Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update style-guide.md #26

Merged
merged 1 commit into from Feb 15, 2019
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Update style-guide.md
Added missing intro block for documentation articles.
Closes Issue #6
  • Loading branch information
Mrt134 committed Feb 14, 2019
commit 2b25edddbc494c44ecf993ee8c3429ab6b3c3cfc
@@ -1,7 +1,7 @@
+++
title = "Style Guide"
menutitle = "Style Guide"
description = "Start Here: Formatting and Quickstart Guide"
description = "Documentation Contributions: Formatting and Quickstart Guide"
pre = "<i class='fa fa-font'></i> "
+++

@@ -22,6 +22,15 @@ Trident documentation will be periodically reviewed and edited to conform to thi
All documentation is stored as Markdown files in the [trident-website](https://github.com/project-trident/trident-website/tree/master/hugo-site/content) repository on GitHub.
These files are published to http://www.project-trident.org as articles.

All articles must begin with a header block with a few specific elements:
```
+++
title = "Article Title"
menutitle = "Article title in website sidebar"
description = "Brief description of article. Appears on the website."
pre = "<i class='fa fa-font'></i> "
+++
```
Every documentation file needs an introduction section explaining the goal of the document and a summary of the most useful procedure.

Trident Basic Style Elements: