-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add README, get documentation build working.
- Loading branch information
Showing
9 changed files
with
83 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,4 @@ | ||
README.md | ||
dist | ||
node_modules | ||
src/documentation/Documentation/Bylaws | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
# The TEI-C website source | ||
|
||
This repository contains the sources for the TEI website and the configuration to run it locally if you need to. If you are editing the website's content, you will only need to be focused on the contents of the `src/` directory, which is laid out like this: | ||
|
||
```txt | ||
src | ||
├── _data | ||
├── _includes | ||
├── _layouts | ||
├── about | ||
│ └── logos | ||
│ └── potential-new-logos | ||
├── activities | ||
│ └── projects | ||
├── assets | ||
│ ├── css | ||
│ ├── img | ||
│ └── js | ||
├── documentation | ||
│ └── Documentation | ||
│ ├── Bylaws | ||
│ ├── TCW | ||
│ └── bin | ||
├── guidelines | ||
├── news | ||
│ ├── 2023 | ||
│ │ ├── 01 | ||
│ │ │ ├── 09 | ||
│ │ │ └── 28 | ||
│ │ ├── 02 | ||
│ │ │ └── 27 | ||
│ │ ├── 08 | ||
│ │ │ ├── 02 | ||
│ │ │ └── 06 | ||
│ │ └── 09 | ||
│ │ └── 24 | ||
│ └── 2024 | ||
├── posts | ||
└── support | ||
└── learn | ||
``` | ||
|
||
Unless you need to change the look and feel of the site, you can ignore any directory prefixed with a `_`. The `assets/` directory contains CSS, JavaScript, and images. | ||
|
||
Content files are mostly written in Markdown. You will notice that each one has a header like | ||
|
||
```txt | ||
--- | ||
layout: page.njk | ||
title: "Customization" | ||
tags: page | ||
--- | ||
``` | ||
|
||
Most markdown files will use the `page.njk` layout. The title will end up being the header title of the HTML page. In a few cases, as in news posts, you will need to supply a `date` in ISO (year-2-digit month-2-digit day) format. For news posts, the date and title will determine the final URL rather than the folder organization. Older posts may be organized into year, month, and day folders, but that is only because of how they were migrated from the old website. It may be convenient to organize them into folders, but it isn't required. | ||
|
||
By default, a file like `src/support.md` will end up being served at a URL like `https://tei-c.org/support`. If you need to change this behavior, you can set the `permalink` property in the header to the URL you desire. | ||
|
||
The TEI Documentation pages are an exception. These are included as a Git submodule in `src/documentation/Documentation` and are TEI files. You probably don't want to edit them locally, but if you do, make sure they get pushed to the Documentation repo. | ||
|
||
The root index pages, `index.en.md` and `index.es.md` are special in that they are set up for the Apache web server to do content negotiation to determine whether to show an English or Spanish version of the landing page depending on the requester's locale. If you use the built in Eleventy serve command, be aware that you won't get a regular index.html file at the root. |
Submodule Documentation
updated
from 5bca8b to 06d47e
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
module.exports = function() { | ||
return { | ||
"layout": "documentation.njk", | ||
"tags": "Working Papers", | ||
"permalink": data => `${data.page.filePathStem.replace("Documentation/TCW", "").replace(".xml", "/index.html")}`, | ||
"eleventyNavigation": { | ||
"parent": "Council" | ||
} | ||
} | ||
} |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
module.exports = function() { | ||
return { | ||
permalink: function(data) { | ||
return `/news/${this.isoDateToPath(data.date)}/${this.slugify(data.title)}/index.html`; | ||
}, | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters