add/ref: update documentation.

This commit is contained in:
manunamz
2023-10-06 11:17:23 -04:00
parent 78c303a597
commit 64cbf45f73
18 changed files with 525 additions and 58 deletions
+28 -23
View File
@@ -4,24 +4,39 @@
An [Astro base blog](https://github.com/withastro/astro/tree/main/examples/blog) with [wikibonsai](https://github.com/wikibonsai/wikibonsai) support.
You can see the live demo [here](https://astro-wikibonsai.netlify.com/).
💐 Display your [🎋 WikiBonsai](https://github.com/wikibonsai/wikibonsai) digital garden for others.
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
## Getting Started
![blog](https://github.com/withastro/astro/assets/2244813/ff10799f-a816-4703-b967-c78997e8323d)
### 1. Clone this Repository
Features:
```
git clone https://github.com/wikibonsai/astro-wikibonsai.git my-blog-name
```
- ✅ Minimal styling (make it your own!)
- ✅ 100/100 Lighthouse performance
- ✅ SEO-friendly with canonical URLs and OpenGraph data
- ✅ Sitemap support
- ✅ RSS Feed support
- ✅ Markdown & MDX support
### 2. Navigate to the directory
## 🚀 Project Structure
```
cd my-blog-name
```
Inside of your Astro project, you'll see the following folders and files:
### 3. Install dependencies
```
npm install
```
### 4. Run
```
npm run dev
```
## 🪴 Project Structure
Inside of your Astro-Wikibonsai project, you'll see the following folders and files:
```text
├── public/
@@ -36,12 +51,6 @@ Inside of your Astro project, you'll see the following folders and files:
└── tsconfig.json
```
#todo
- entries
- index
- when defining the tree in 'i.bonsai.md', be sure there is a single root node so that the entire tree is processed properly.
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
@@ -50,7 +59,7 @@ The `src/content/` directory contains "collections" of related Markdown and MDX
Any static assets, like images, can be placed in the `public/` directory.
## 🧞 Commands
## 🧚 Commands
All commands are run from the root of the project, from a terminal:
@@ -65,8 +74,4 @@ All commands are run from the root of the project, from a terminal:
## 👀 Want to learn more?
Check out [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
## Credit
This theme is based off of the lovely [Bear Blog](https://github.com/HermanMartinus/bearblog/).
Check out the [Astro documentation](https://docs.astro.build) or [WikiBonsai documentation](https://github.com/wikibonsai/wikibonsai/).