From a77965550d752f33bca922ff4fe9bed4cc972eeb Mon Sep 17 00:00:00 2001 From: developomp Date: Wed, 13 Oct 2021 11:44:12 +0900 Subject: [PATCH] added documentation setup instructions --- docs/5-docs/1-overview.md | 1 + docs/5-docs/2-setting-up.md | 29 +++++++++++++++++++++++++++++ docs/5-docs/_category_.json | 4 ++++ 3 files changed, 34 insertions(+) create mode 100644 docs/5-docs/1-overview.md create mode 100644 docs/5-docs/2-setting-up.md create mode 100644 docs/5-docs/_category_.json diff --git a/docs/5-docs/1-overview.md b/docs/5-docs/1-overview.md new file mode 100644 index 0000000..07dd0c5 --- /dev/null +++ b/docs/5-docs/1-overview.md @@ -0,0 +1 @@ +# Overview diff --git a/docs/5-docs/2-setting-up.md b/docs/5-docs/2-setting-up.md new file mode 100644 index 0000000..162c3ab --- /dev/null +++ b/docs/5-docs/2-setting-up.md @@ -0,0 +1,29 @@ +# Setting Up + +## Steps + +### Local + +1. Install node.js and yarn. + +2. Clone the [documentation repository](https://github.com/llama-bot/llama-bot-docs). + + ```bash + git clone https://github.com/llama-bot/llama-bot-docs + ``` + +3. Install dependencies. + + ```bash + yarn install + ``` + +4. Test locally. Live edit is supported. + + ```bash + yarn start + ``` + +### Deployment + +1. Follow the [instructions from docusaurus](https://docusaurus.io/docs/deployment#deploying-to-github-pages) diff --git a/docs/5-docs/_category_.json b/docs/5-docs/_category_.json new file mode 100644 index 0000000..bdb6cc7 --- /dev/null +++ b/docs/5-docs/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Docs", + "position": 5 +}