From 7cc14fb6350acd3a02d0e1b7d2f444ce42d4cf25 Mon Sep 17 00:00:00 2001 From: Zachary Klosko Date: Mon, 7 Dec 2020 17:38:55 -0500 Subject: [PATCH] Adding docs readme --- docs/README | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/docs/README b/docs/README index 181ed94d8..9a3e60a32 100644 --- a/docs/README +++ b/docs/README @@ -1,8 +1,33 @@ # Contributing to the docs +**Note:** External components for the website (Bootstrap, jQuery, Font Awesome etc.) are +now being served from CDNs instead of from the repo itself. You must be connected to the internet in order to test the site. + ## Running Jekyll +Follow [these instructions](https://jekyllrb.com/docs/installation/) to install Ruby, then: + ``` +# Install Jekyll and Bundler gems +gem install jekyll bundler + +# Install Jekyll dependencies +cd docs #must run in docs folder bundler install + +# Run Jekyll server jekyll serve -``` \ No newline at end of file +``` + +## Where to find things + +``` +/docs -> main folder +|-- /_docs -> actual documentation lives here in markdown files +|-- /_includes -> the equilivant of components, can be inserted into HTML files +|-- /_layouts -> the HTML styling templates that make up each page +|-- /css -> CSS files live here +|-- /img -> all images, screenshots live here +|-- _config.yml -> main settings file for Jekyll +|-- Gemfile -> dependencies file for Jekyll +```