Initial commit.

This commit is contained in:
Marc MacLeod
2018-01-19 11:48:39 -06:00
commit 398321d2f8

37
README.md Normal file
View File

@@ -0,0 +1,37 @@
# Stoplight Docs
The time is nigh!
## Templates
## Articles
## Assets
Assets (like images) should be placed in the assets/images folder.
JPEG, PNG, and GIF image formats are supported. Images can be included in markdown by using the path to the image.
For example:
```markdown
<!--- Inside of ./articles/organizations/overview.md --->
# Organization Overview
![my image](./assets/images/my-image.jpg)
```
## Linking
Article A can link to Article B by using the file path to article B. This file path is relative to the root of the project.
For example:
```markdown
<!--- Inside of ./articles/organizations/overview.md --->
# Organization Overview
A link to [Projects Overview](./articles/projects/overview.md).
```