FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
frontend/docs/how-to-create-a-doc-file.md at master · devhttps/frontend · GitHub
devhttps
/
frontend
Public
forked from
guardian/frontend
Notifications
You must be signed in to change notification settings
Fork
0
Star
0
Code
Pull requests
0
Actions
Projects
Wiki
Security and quality
0
Insights
Additional navigation options
Code
Pull requests
Actions
Projects
Wiki
Security and quality
Insights
Expand file tree
Breadcrumbs
frontend
/
docs
/
how-to-create-a-doc-file.md
Copy path
More file actions
More file actions
Latest commit
History
History
History
9 lines (7 loc) · 547 Bytes
Breadcrumbs
frontend
/
docs
/
how-to-create-a-doc-file.md
Copy path
File metadata and controls
9 lines (7 loc) · 547 Bytes
Raw
Copy raw file
Download raw file
Outline
Edit and raw actions
META: How to create a new documentation file
Documentation conventions
Find the correct subdirectory your new documentation file belongs to.
Every documentation file should be markdown (with .md extension).
First line of every documentation file should contain its title (used to generated the table of content).
Store all the images in an /images subfolder in the same directory the document referencing them will be.
Table of content (TOC) is generated automatically with every commit, all changes will be staged accordingly.
Back
|
FazBrowse Home
|
New Git URL