Skip to content

Commit ff425fe

Browse files
committed
docs(README): Update site content addition instructions and clarify markdown file structure
1 parent 790ff8e commit ff425fe

1 file changed

Lines changed: 10 additions & 9 deletions

File tree

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -70,21 +70,22 @@ The project should be available at http://localhost:5173/.
7070

7171
## Adding content to the site
7272

73-
Static pages are added to the site via [markdown files](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax). Markdown support is implemented in the
74-
project using [mdsvex](https://mdsvex.pngwn.io/). Pages are added to the site by
75-
adding a new entry to the [frontend/src/routes/](frontend/src/routes/) directory.
73+
Static pages are added to the site via [markdown files](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).
74+
Markdown support is implemented in the project using [mdsvex](https://mdsvex.pngwn.io/).
7675

77-
First, create a new sub-directory in the routes directory. For example, to add
78-
a new page called "about", create a new directory called `about` and add
79-
a `+page.md` file to it.
76+
Pages are added to the site by adding a new markdown file to the [frontend/src/pages/](frontend/src/pages/)
77+
directory. Nested pages are supported by creating a new directory and adding a child markdown file to it.
8078

81-
The `+page.md` file should contain the markdown content for the page. The page
82-
will be added to the site and will be accessible at `http://PROJECT_URL/about`.
79+
The file should contain the markdown content for the page. The page will be added to the site and will be accessible at a URL that mirrors the file structure. For example:
80+
81+
- `frontend/src/pages/about.md` becomes `http://PROJECT_URL/about`
82+
- `frontend/src/pages/about/periods.md` becomes `http://PROJECT_URL/about/periods`
8383

8484
## Editorial workflow
8585

8686
New editorial content should be added in the `research` branch. This branch is
87-
automatically deployed to the preview site in [GitHub Pages](https://kingsdigitallab.github.io/corpus-building/), together with the `develop` and `main` branches.
87+
automatically deployed to the preview site in [GitHub Pages](https://kingsdigitallab.github.io/corpus-building/),
88+
together with the `develop` and `main` branches.
8889

8990
Content that needs to be visible to the public should be added to the `main`
9091
branch. Content to the `main` branch needs to be added via a pull request.

0 commit comments

Comments
 (0)