Skip to content

Commit

Permalink
Merge pull request #186 from AlexsLemonade/sjspielman/contributing-ne…
Browse files Browse the repository at this point in the history
…w-navigation

Update contributing without references to bold headers
  • Loading branch information
sjspielman authored Mar 14, 2024
2 parents b0e5039 + ec38754 commit 625ed43
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,9 @@ Documentation is written as a series of markdown files nested by topic in direct
- Each top-level directory should contain an `index.md` file with an overall description of what that section contains.
- The `index.md` should have an L1 header with the same title as the `navbar` section.
- Markdown files in each directory represent sections shown along the left sidebar.
- Nested directories within each `navbar` section should be used to add an additional bold header on the left sidebar and _may_ also have an `index.md` file.
- Markdown files within each nested directory will fall under this additional bold header.
- Nested directories within each `navbar` section should be used to add an sections along the left sidebar.
- We can have multiple levels of nested directories.
- Nested directories may also have an `index.md` file with an L1 header and an overall description of what that section contains.
- Any visual aids used in the docs should be placed in `docs/img` (see the [adding images section](#adding-images)).

## Adding new documentation
Expand Down
3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ theme:
- navigation.tabs # persistent navbar on the top
- navigation.tabs.sticky # sticky navbar
- navigation.indexes # allow index pages to serve as overview pages for sections
- navigation.expand # collapsible sections are expanded by default

plugins:
- search # search bar
Expand All @@ -23,6 +24,8 @@ markdown_extensions:
- admonition # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#admonition
- attr_list # https://github.com/squidfunk/mkdocs-material/blob/master/docs/setup/extensions/python-markdown.md#attribute-lists
- md_in_html # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#markdown-in-html


# Here is the basic structure of our navigation setup.
#nav:
# - Navbar section: <!-- Contents for this navbar section are stored in the directory called `section-path` -->
Expand Down

0 comments on commit 625ed43

Please sign in to comment.