Skip to content

Commit

Permalink
README: document adding a page
Browse files Browse the repository at this point in the history
Signed-off-by: William Woodruff <william@trailofbits.com>
  • Loading branch information
woodruffw authored and ewdurbin committed Jul 2, 2024
1 parent 48067cc commit 42fe963
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,10 @@ edit documents.

Once it has started, navigate to [http://localhost:10000](http://localhost:10000)
in your browser! Any edits made will render as you save your work.

### Adding new pages

To add a new page, you'll need to do two things:

1. Create the page itself in the appropriate location under [`./docs`](./docs/).
2. Add the page to the `nav` hierarchy in [`mkdocs.yml`](./mkdocs.yml).

0 comments on commit 42fe963

Please sign in to comment.