generated from bethropolis/gena
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
6 additions
and
69 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,76 +1,13 @@ | ||
| --- | ||
| title: "Installation" | ||
| title: "Introduction" | ||
| outline: ["what-is-gena" , "getting-started", "installation","configuring-the-sidebar | ||
| ", "adding-content", "deployment-and-build", "other-helpful-docs"] | ||
| --- | ||
|
|
||
| # what is gena? | ||
| It is a ready template to help you get strarted writting documentation as quick as possible. | ||
|
|
||
| It is built with `Astro` + `tailwindCSS` + `mdx` | ||
|
|
||
| ## getting started | ||
|
|
||
| ### installation | ||
| Read the [installation guide](./installation). | ||
|
|
||
| ### configuring the sidebar | ||
|
|
||
| the left sidebar is configuration is on the `src/content.ts` file. <br/> | ||
| edit the file in order to change the content of the sidebar. | ||
|
|
||
| ```ts | ||
| // src/content.ts | ||
| export const sidebarStructure = [ | ||
| { | ||
| label: "Getting Started", | ||
| children: [ | ||
| { | ||
| label: "introduction", | ||
| path: "./docs/introduction", | ||
| }, | ||
| { | ||
| label: "installation", | ||
| path: "./docs/installation", | ||
| }, | ||
| ], | ||
| } | ||
| ]; | ||
| ``` | ||
| <br/> | ||
| configuring the right sidebar happens in the markdown/mdx file in the `content` folder. | ||
|
|
||
| example `content/docs/introduction.mdx`. | ||
|
|
||
|
|
||
| ```md | ||
| --- | ||
| title: "Introduction" | ||
| outline: ["getting-started", "installation"] | ||
| --- | ||
|
|
||
| rest of the markdown... | ||
| ``` | ||
| <br/> | ||
|
|
||
| ### adding content | ||
|
|
||
| To add more content to the template, just add more `markdown\mdx` files to the `content/docs` directory.<br/> | ||
| The routing is done automatically by | ||
| Astro, [read about router here](https://docs.astro.build/core-concepts/routing/). | ||
|
|
||
| note: | ||
| > To change it from the docs directory you'll have to change `src/content.ts` | ||
| ```js | ||
| export const docsDir = "docs"; | ||
| ``` | ||
| <br/> | ||
| # What is this? | ||
|
|
||
| ### deployment and build | ||
| static files are generated hence your docs can be deployed anywhere you want, [read more here](https://docs.astro.build/guides/deploy/). | ||
| <br/> | ||
| These documents are intended to inspire key conversations and practical steps that will lead to: | ||
|
|
||
| ### other helpful docs | ||
| 1. [Astro](https://astro.build/) | ||
| 2. [tailwindcss](https://tailwindcss.com/) | ||
| 3. [mdx](https://mdxjs.com/) | ||
| - a collective that makes informed decisions | ||
| - a transparent sharing of information that lead up to specific decision | ||
| - an informed and empowered collective |