https://github.com/bethropolis/gena
an astro template for writing docs fast using markdown.
https://github.com/bethropolis/gena
Last synced: about 1 year ago
JSON representation
an astro template for writing docs fast using markdown.
- Host: GitHub
- URL: https://github.com/bethropolis/gena
- Owner: bethropolis
- License: mit
- Created: 2023-07-31T07:59:16.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-12T05:37:35.000Z (over 1 year ago)
- Last Synced: 2024-09-12T15:08:10.189Z (over 1 year ago)
- Language: Astro
- Homepage: https://bethropolis.github.io/gena/
- Size: 1.09 MB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gena
[](https://github.com/bethropolis/gena/actions/workflows/astro.yml)
An astro ready made template for writing docs fast using markdown.
# Installation
### cloning repository
you'll have to first clone the repository.
```
git clone https://github.com/bethropolis/gena.git
```
### installing
you'll then install all the projects dependancies.
you can use npm, yarn pnpm e.t.c
```
npm install
```
### developing
you'll have to run the development server for easy development.
```
npm run dev
```
### configuring the sidebar
the left sidebar is configuration is on the `src/content.ts` file.
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",
},
],
}
];
```
configuring the right sidebar happens in the markdown/mdx file in the `content` folder.
example `content/docs/introduction.mdx`.
```m
---
title: "Introduction"
outline: ["getting-started", "installation"]
---
rest of the markdown...
```
### adding content
To add more content to the template, just add more `markdown\mdx` files to the `content/docs` directory.
The routing is done automatically by
Astro, [read about router here](https://docs.astro.build/core-concepts/routing/).
### 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/).
to build run:
```
npm run build
```
## License
MIT license (do what you want)