From 398321d2f860a1c7437fbaa332f1b3f1bf0574bb Mon Sep 17 00:00:00 2001 From: Marc MacLeod Date: Fri, 19 Jan 2018 11:48:39 -0600 Subject: [PATCH] Initial commit. --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..53e3d06 --- /dev/null +++ b/README.md @@ -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 + + +# 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 + + +# Organization Overview + +A link to [Projects Overview](./articles/projects/overview.md). +```