documentation site files moved into a separate folder

Ananto30 · Apr 6, 2023 · 43c3d44 · 43c3d44
1 parent db4470f
commit 43c3d44
Show file tree

Hide file tree

Showing 36 changed files with 50 additions and 10 deletions.
diff --git a/.gitignore b/.gitignore
@@ -17,7 +17,3 @@ coverage.*
 # code generation test directory
 test_codegen
 
-# Documentation 
-node_modules
-docs/.vitepress/cache
-docs/.vitepress/dist
diff --git a/documentation/.gitignore b/documentation/.gitignore
@@ -0,0 +1,3 @@
+node_modules
+docs/.vitepress/cache
+docs/.vitepress/dist
diff --git a/documentation/README.md b/documentation/README.md
@@ -0,0 +1,47 @@
+# Documentation Guide
+
+This documentation template has been built with [vitepress](https://vitepress.dev)
+
+Use this extention while writing documentation : [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)
+
+## Steps
+
+Step 1: Clone the repository
+
+```bash
+git clone git@github.com:Ananto30/zero.git
+```
+
+Step 2: Move terminal inside documentation directory
+
+```bash
+cd documentation
+```
+
+Step 3: Install npm dependencies (your device should already have npm installed)
+
+```bash
+npm install
+```
+
+Step 4: Run the documentation site on browser for development
+
+```bash
+npm run docs:dev
+```
+
+Step 5: build website to publish
+
+```bash
+npm run docs:build
+```
+
+This command will create website files inside `documentation/docs/.vitepress/dist` directory. Inside `dist` directory generated website files will be avaliable.
+
+Step 6 : preview the site locally before publishing.
+
+```bash
+npm run docs:preview
+```
+
+If everything is good, you can publish the website using the files existing inside `dist` directory.
diff --git a/docs/.vitepress/config.js → documentation/docs/.vitepress/config.js b/docs/.vitepress/config.js → documentation/docs/.vitepress/config.js
@@ -16,12 +16,6 @@ export default {
       }
     },
 
-    // Google Analytics
-    // head: [
-    //   [ 'script', { async: '' , src: "https://www.googletagmanager.com/gtag/js?id=G-XXXXXXXXXX" } ],
-    //   [ 'script', {} , "window.dataLayer = window.dataLayer || [];\nfunction gtag(){dataLayer.push(arguments);}\ngtag('js', new Date());\ngtag('config', 'G-XXXXXXXXXX');" ],
-    // ],
-
     themeConfig: {
       siteTitle: 'Zero',
       logo : '/logo.png',

diff --git a/...epress/theme/components/AsideSponsors.vue → ...epress/theme/components/AsideSponsors.vue b/...epress/theme/components/AsideSponsors.vue → ...epress/theme/components/AsideSponsors.vue
diff --git a/...tepress/theme/components/BuyMeACoffee.vue → ...tepress/theme/components/BuyMeACoffee.vue b/...tepress/theme/components/BuyMeACoffee.vue → ...tepress/theme/components/BuyMeACoffee.vue
diff --git a/.../.vitepress/theme/components/Sponsors.vue → .../.vitepress/theme/components/Sponsors.vue b/.../.vitepress/theme/components/Sponsors.vue → .../.vitepress/theme/components/Sponsors.vue
diff --git a/docs/.vitepress/theme/custom.css → ...entation/docs/.vitepress/theme/custom.css b/docs/.vitepress/theme/custom.css → ...entation/docs/.vitepress/theme/custom.css
diff --git a/docs/.vitepress/theme/data/example.json → ...n/docs/.vitepress/theme/data/example.json b/docs/.vitepress/theme/data/example.json → ...n/docs/.vitepress/theme/data/example.json
diff --git a/docs/.vitepress/theme/data/sponsor.json → ...n/docs/.vitepress/theme/data/sponsor.json b/docs/.vitepress/theme/data/sponsor.json → ...n/docs/.vitepress/theme/data/sponsor.json
diff --git a/docs/.vitepress/theme/index.js → documentation/docs/.vitepress/theme/index.js b/docs/.vitepress/theme/index.js → documentation/docs/.vitepress/theme/index.js
diff --git a/docs/.vitepress/theme/layouts/AdsLayout.vue → ...cs/.vitepress/theme/layouts/AdsLayout.vue b/docs/.vitepress/theme/layouts/AdsLayout.vue → ...cs/.vitepress/theme/layouts/AdsLayout.vue
diff --git a/docs/advanced/code_generation.md → ...entation/docs/advanced/code_generation.md b/docs/advanced/code_generation.md → ...entation/docs/advanced/code_generation.md
diff --git a/docs/basic/middleware.md → documentation/docs/basic/middleware.md b/docs/basic/middleware.md → documentation/docs/basic/middleware.md
diff --git a/docs/basic/request.md → documentation/docs/basic/request.md b/docs/basic/request.md → documentation/docs/basic/request.md
diff --git a/docs/basic/response.md → documentation/docs/basic/response.md b/docs/basic/response.md → documentation/docs/basic/response.md
diff --git a/docs/basic/routing.md → documentation/docs/basic/routing.md b/docs/basic/routing.md → documentation/docs/basic/routing.md
diff --git a/docs/concept/architecture.md → documentation/docs/concept/architecture.md b/docs/concept/architecture.md → documentation/docs/concept/architecture.md
diff --git a/docs/concept/lifecycle.md → documentation/docs/concept/lifecycle.md b/docs/concept/lifecycle.md → documentation/docs/concept/lifecycle.md
diff --git a/docs/getting_started/about.md → documentation/docs/getting_started/about.md b/docs/getting_started/about.md → documentation/docs/getting_started/about.md
diff --git a/docs/getting_started/benchmark.md → ...ntation/docs/getting_started/benchmark.md b/docs/getting_started/benchmark.md → ...ntation/docs/getting_started/benchmark.md
diff --git a/docs/getting_started/install.md → ...mentation/docs/getting_started/install.md b/docs/getting_started/install.md → ...mentation/docs/getting_started/install.md
diff --git a/docs/getting_started/overview.md → ...entation/docs/getting_started/overview.md b/docs/getting_started/overview.md → ...entation/docs/getting_started/overview.md
diff --git a/docs/getting_started/uninstall.md → ...ntation/docs/getting_started/uninstall.md b/docs/getting_started/uninstall.md → ...ntation/docs/getting_started/uninstall.md
diff --git a/docs/index.md → documentation/docs/index.md b/docs/index.md → documentation/docs/index.md
diff --git a/docs/prologue/contribution_guide.md → ...ation/docs/prologue/contribution_guide.md b/docs/prologue/contribution_guide.md → ...ation/docs/prologue/contribution_guide.md
diff --git a/docs/prologue/release_note.md → documentation/docs/prologue/release_note.md b/docs/prologue/release_note.md → documentation/docs/prologue/release_note.md
diff --git a/docs/prologue/upgrade_guide.md → documentation/docs/prologue/upgrade_guide.md b/docs/prologue/upgrade_guide.md → documentation/docs/prologue/upgrade_guide.md
diff --git a/docs/public/advertisement/bmc.jpg → ...ntation/docs/public/advertisement/bmc.jpg b/docs/public/advertisement/bmc.jpg → ...ntation/docs/public/advertisement/bmc.jpg
diff --git a/docs/public/advertisement/bmc.png → ...ntation/docs/public/advertisement/bmc.png b/docs/public/advertisement/bmc.png → ...ntation/docs/public/advertisement/bmc.png
diff --git a/docs/public/badge.png → documentation/docs/public/badge.png b/docs/public/badge.png → documentation/docs/public/badge.png
diff --git a/docs/public/logo.png → documentation/docs/public/logo.png b/docs/public/logo.png → documentation/docs/public/logo.png
diff --git a/docs/testing/getting_started.md → ...mentation/docs/testing/getting_started.md b/docs/testing/getting_started.md → ...mentation/docs/testing/getting_started.md
diff --git a/docs/testing/http_testing.md → documentation/docs/testing/http_testing.md b/docs/testing/http_testing.md → documentation/docs/testing/http_testing.md
diff --git a/package-lock.json → documentation/package-lock.json b/package-lock.json → documentation/package-lock.json
diff --git a/package.json → documentation/package.json b/package.json → documentation/package.json