diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..71d43a0 --- /dev/null +++ b/.env.example @@ -0,0 +1,3 @@ +ALGOLIA_APP_ID= +ALGOLIA_API_KEY= +ALGOLIA_INDEX_NAME= \ No newline at end of file diff --git a/.gitignore b/.gitignore index a7ae08f..102d767 100644 --- a/.gitignore +++ b/.gitignore @@ -48,8 +48,9 @@ typings/ # TypeScript cache *.tsbuildinfo -# Optional npm cache directory +# Optional npm/yarn cache directory .npm +.yarn # Optional eslint cache .eslintcache @@ -107,3 +108,9 @@ dist .idea **/.DS_Store .docusaurus + +*.gz + +# generated docs folders +docs/react-hooks/ +docs/sdk/api-reference/ \ No newline at end of file diff --git a/.yarnrc.yml b/.yarnrc.yml new file mode 100644 index 0000000..951392e --- /dev/null +++ b/.yarnrc.yml @@ -0,0 +1,14 @@ +compressionLevel: mixed + +enableGlobalCache: false + +enableColors: true + + +nodeLinker: node-modules + +injectEnvironmentFiles: [ + ".env.local?", + ".env.development.local?", + ".env?" +] diff --git a/README.md b/README.md index aaba2fa..1e95566 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,38 @@ -# Website +# AKASHA Documentation This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. +## Local Development + +### Init and Update Submodules +First time running this project locally? please use; +``` +$ git submodule update --init --recursive +``` + +This fetches and updates the linked submodules. Subsequently, you may use; +``` +$ git submodule update --recursive --remote +``` + +### Set up Algolia +- Create an account on Algolia (if you already have one, skip to next step) +- Create an Index and copy out its `Application ID` and `Search API Key` +- Update the matching fields in the [config file](./docusaurus.config.js) +- Read more about the DocSearch Migration [here](https://docusaurus.io/blog/2021/11/21/algolia-docsearch-migration) + ### Installation ``` $ yarn ``` -### Local Development +### Bootstrap files +``` +$ yarn run bootstrap +``` +### Start Local Server ``` $ yarn start ``` @@ -24,7 +47,7 @@ $ yarn build This command generates static content into the `build` directory and can be served using any static contents hosting service. -### Deployment +### Deploy Using SSH: diff --git a/akasha-core b/akasha-core index 1934fda..72c56d5 160000 --- a/akasha-core +++ b/akasha-core @@ -1 +1 @@ -Subproject commit 1934fda0c5f7f776abefb6b62fa71582a43f210a +Subproject commit 72c56d5f55f28a7a657b514487429262417b0011 diff --git a/docs/design-system/_category.json b/docs/design-system/_category.json new file mode 100644 index 0000000..b86110e --- /dev/null +++ b/docs/design-system/_category.json @@ -0,0 +1,4 @@ +{ + "label": "Design System", + "position": 4 +} diff --git a/docs/design-system/components/_category.json b/docs/design-system/components/_category.json new file mode 100644 index 0000000..50c4b6d --- /dev/null +++ b/docs/design-system/components/_category.json @@ -0,0 +1,4 @@ +{ + "label": "Design System Components", + "position": 2 +} diff --git a/docs/design-system/components/index.md b/docs/design-system/components/index.md new file mode 100644 index 0000000..8a9cee3 --- /dev/null +++ b/docs/design-system/components/index.md @@ -0,0 +1,6 @@ +--- +sidebar_position: 2 +sidebar_label: Design System Components +--- + +# Design System Components \ No newline at end of file diff --git a/docs/design-system/core/_category.json b/docs/design-system/core/_category.json new file mode 100644 index 0000000..c9d916c --- /dev/null +++ b/docs/design-system/core/_category.json @@ -0,0 +1,4 @@ +{ + "label": "Design System Core", + "position": 1 +} diff --git a/docs/design-system/core/index.md b/docs/design-system/core/index.md new file mode 100644 index 0000000..b38a3ad --- /dev/null +++ b/docs/design-system/core/index.md @@ -0,0 +1,59 @@ +--- +sidebar_position: 1 +sidebar_label: Design System Core +--- + +# Design System Core + +## Button + +A button component presents two variants: `primary` for the call-to-action use case and `secondary` for regular usage. It usually has rounder borders, can display an icon, or it can be text only. + +```tsx +