Skip to content

Commit

Permalink
Updated guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
PTKay committed Feb 3, 2022
1 parent 4df84d9 commit 5afbbe3
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,13 @@ GitHub Page with tools and guides for modding Sonic games, powered by [Material
Page layout is defined in `mkdocs.yml`. There you can add new pages and sections to HedgeDocs, by pointing the pages to a markdown file.

## New Page Guidelines
- Be sure to follow the general structure while adding new pages.
- Make sure that each markdown file has a title. The first title in the markdown file is what's going to show up in the webpage's search results.
When adding new pages, please follow these guidelines (check pre-existing pages for examples):

- Be sure to follow the general structure while adding new pages
- Make sure that each markdown file has a title (specified with `#`). The first title in the markdown file is what's going to show up in the webpage's search results
- Guides should include an info box before the title, listing the tools that they're using. The info box should include a link to the relevant tools page
- If the tools aren't included in the tools page, add them. If that doesn't make sense, then add the links to said tools in the info box.
- Not mandatory, but please try to add a description metadata to every new page. More info below...

## Material for MkDocs features
Since HedgeDocs uses Material for MkDocs, you might want to check its [references](https://squidfunk.github.io/mkdocs-material/reference/) to better understand its features. You can use plain markdown, but you can also use admonitions, buttons, and even icons from Font Awesome.
Expand Down

0 comments on commit 5afbbe3

Please sign in to comment.