https://github.com/plexidev/quick.db-guide

Current guide website for quick.db.
https://github.com/plexidev/quick.db-guide

Last synced: about 2 months ago
JSON representation

Current guide website for quick.db.

• Host: GitHub
• URL: https://github.com/plexidev/quick.db-guide
• Owner: plexidev
• Created: 2023-02-14T21:51:41.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-01-16T18:28:51.000Z (12 months ago)
• Last Synced: 2024-03-02T16:34:31.496Z (10 months ago)
• Language: Astro
• Homepage: https://guide.plexidev.org
• Size: 937 KB
• Stars: 1
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Quick.db Documentation

https://docs.plexidev.org 


https://quickdb.js.org

## 🧞 Commands

All commands are run from the root of the project, from a terminal:

| Command                | Action                                           |

| :--------------------- | :----------------------------------------------- |

| `npm install`          | Installs dependencies                            |

| `npm run dev`          | Starts local dev server at `localhost:3000`      |

| `npm run build`        | Build your production site to `./dist/`          |

| `npm run preview`      | Preview your build locally, before deploying     |

| `npm run astro ...`    | Run CLI commands like `astro add`, `astro check` |

| `npm run astro --help` | Get help using the Astro CLI                     |

## Page metadata

Astro uses frontmatter in Markdown pages to choose layouts and pass properties to those layouts. If you are using the default layout, you can customize the page in many different ways to optimize SEO and other things. For example, you can use the `title` and `description` properties to set the document title, meta title, meta description, and Open Graph description.

````markdown

---

title: Example title

description: Really cool docs example that uses Astro

layout: ../../layouts/MainLayout.astro

---

### Sidebar navigation

The sidebar navigation is controlled by the `SIDEBAR` variable in your `src/config.ts` file. You can customize the sidebar by modifying this object. A default, starter navigation has already been created for you.

```ts

export const SIDEBAR = {

    en: [

        { text: "Section Header", header: true },

        { text: "Introduction", link: "en/introduction" },

        { text: "Page 2", link: "en/page-2" },

        { text: "Page 3", link: "en/page-3" },

        { text: "Another Section", header: true },

        { text: "Page 4", link: "en/page-4" },

    ],

};

```

````

Note the top-level `en` key: This is needed for multi-language support. You can change it to whatever language you'd like, or add new languages as you go. More details on this below.