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

@ -9,12 +9,24 @@ export default defineConfig({
// https://vitepress.dev/reference/default-theme-config
nav: [
{ text: 'Home', link: '/' },
{ text: 'Examples', link: '/markdown-examples' }
{ text: 'Examples', link: '/markdown-examples' },
{ text: 'API', link: '/api/jecs.md' }
],
sidebar: [
sidebar: {
"/api/": [
{
text: 'Overview',
text: "API reference",
items: [
{ text: "jecs", link: "/api/jecs" },
{ text: "World", link: "/api/world" },
{ text: "Query", link: "/api/query" }
]
}
],
"/learn/": [
{
text: "Introduction",
items: [
{ text: 'Getting Started', link: '/overview/get-started' },
{ text: 'First Jecs Project', link: '/overview/first-jecs-project' }
@ -28,18 +40,15 @@ export default defineConfig({
{ text: 'Queries', link: '/concepts/queries' },
]
},
{
text: 'References',
items: [
{ text: 'API Reference', link: '/api' },
]
},
{
text: "FAQ",
items: [
{ text: 'How can I contribute?', link: '/faq/contributing' }
]
},
],
"/contributing/": [
{
text: 'Contributing',
items: [
@ -48,7 +57,8 @@ export default defineConfig({
{ 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.