Improve docs (#90)

* Add method

* Remove unnecessary shadowed variable

* Separate pages
This commit is contained in:
Marcus 2024-07-28 03:06:09 +02:00 committed by GitHub
parent 49305f73dd
commit a3eb2cddc3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
13 changed files with 203 additions and 193 deletions

View file

@ -2,56 +2,66 @@ import { defineConfig } from 'vitepress'
// https://vitepress.dev/reference/site-config // https://vitepress.dev/reference/site-config
export default defineConfig({ export default defineConfig({
title: "Jecs", title: "Jecs",
base: "/jecs/", base: "/jecs/",
description: "A VitePress Site", description: "A VitePress Site",
themeConfig: { themeConfig: {
// https://vitepress.dev/reference/default-theme-config // https://vitepress.dev/reference/default-theme-config
nav: [ nav: [
{ text: 'Home', link: '/' }, { text: 'Home', link: '/' },
{ text: 'Examples', link: '/markdown-examples' } { text: 'Examples', link: '/markdown-examples' },
], { text: 'API', link: '/api/jecs.md' }
],
sidebar: [ sidebar: {
{ "/api/": [
text: 'Overview', {
items: [ text: "API reference",
{ text: 'Getting Started', link: '/overview/get-started' }, items: [
{ text: 'First Jecs Project', link: '/overview/first-jecs-project' } { text: "jecs", link: "/api/jecs" },
] { text: "World", link: "/api/world" },
}, { text: "Query", link: "/api/query" }
{ ]
text: 'Concepts', }
items: [ ],
{ text: 'Entities', link: '/concepts/entities' }, "/learn/": [
{ text: 'Static Components', link: '/concepts/static-components' }, {
{ text: 'Queries', link: '/concepts/queries' }, text: "Introduction",
] items: [
}, { text: 'Getting Started', link: '/overview/get-started' },
{ { text: 'First Jecs Project', link: '/overview/first-jecs-project' }
text: 'References', ]
items: [ },
{ text: 'API Reference', link: '/api' }, {
] text: 'Concepts',
}, items: [
{ { text: 'Entities', link: '/concepts/entities' },
text: "FAQ", { text: 'Static Components', link: '/concepts/static-components' },
items: [ { text: 'Queries', link: '/concepts/queries' },
{ text: 'How can I contribute?', link: '/faq/contributing' } ]
] },
}, {
{ text: "FAQ",
text: 'Contributing', items: [
items: [ { text: 'How can I contribute?', link: '/faq/contributing' }
{ text: 'Contribution Guidelines', link: '/contributing/guidelines'}, ]
{ text: 'Submitting Issues', link: '/contributing/issues'}, },
{ text: 'Submitting Pull Requests', link: '/contributing/pull-requests'},
]
}
],
socialLinks: [ ],
{ icon: 'github', link: 'https://github.com/vuejs/vitepress' } "/contributing/": [
] {
} text: 'Contributing',
items: [
{ text: 'Contribution Guidelines', link: '/contributing/guidelines' },
{ text: 'Submitting Issues', link: '/contributing/issues' },
{ text: 'Submitting Pull Requests', link: '/contributing/pull-requests' },
]
}
]
},
socialLinks: [
{ icon: 'github', link: 'https://github.com/vuejs/vitepress' }
]
}
}) })

View file

@ -1,3 +0,0 @@
## TODO
This is a TODO stub.

View file

@ -1,3 +0,0 @@
## TODO
This is a TODO stub.

View file

@ -1,3 +0,0 @@
## TODO
This is a TODO stub.

View file

@ -0,0 +1,3 @@
## TODO
This is a TODO stub.

View file

@ -0,0 +1,3 @@
## TODO
This is a TODO stub.

View file

@ -0,0 +1,3 @@
## TODO
This is a TODO stub.

View file

@ -0,0 +1,3 @@
## TODO
This is a TODO stub.

View file

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 34 KiB

View file

Before

Width:  |  Height:  |  Size: 3.9 KiB

After

Width:  |  Height:  |  Size: 3.9 KiB

View file

@ -1,3 +0,0 @@
## TODO
This is a TODO stub.