diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..9b3d0e5 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,42 @@ +## Running the site locally + +To run the site locally, you can just run + +```bash +./run_site.sh +``` + +It will print a message to the console for the address to view the website. + +### Requirements + +There are some installation requirements to be able to run it locally. + +1. Install ruby & build essentials + + ```bash + sudo apt update + sudo apt install ruby ruby-dev build-essential + ``` + +2. Install bundler + + ```bash + sudo gem install bundler + ``` + +3. Install dependencies + + ```bash + bundle install + ``` + + - If you run into a permissions issue, you can try setting `export BUNDLE_PATH=~/.gems`. + +## To add a new section for navigation + +You are going to need to modified the files above to create a new changes such as delete section, add a new section. However, if you just need to do a simple redirect, you can just modified ``_data/navigation.yml``. + +1. ``_data/navigation.yml`` +2. ``_config.yml`` +3. Add gitignore on the directory ``.gitignore``, since we are going to pull this from the system diff --git a/docs/Readme.md b/docs/Readme.md deleted file mode 100644 index ef027e5..0000000 --- a/docs/Readme.md +++ /dev/null @@ -1,9 +0,0 @@ -## Tutorials - -## To add a new section for navigation - -You are going to need to modified the files above to create a new changes such as delete section, add a new section. However, if you just need to do a simple redirect, you can just modified ``_data/navigation.yml``. - -1. ``_data/navigation.yml`` -2. ``_config.yml`` -3. Add gitignore on the directory ``.gitignore``, since we are going to pull this from the system diff --git a/docs/googled556e8ebb4c45d9a.html b/docs/googled556e8ebb4c45d9a.html new file mode 100644 index 0000000..8be5804 --- /dev/null +++ b/docs/googled556e8ebb4c45d9a.html @@ -0,0 +1 @@ +google-site-verification: googled556e8ebb4c45d9a.html \ No newline at end of file