mirror of
https://github.com/Ukendio/jecs.git
synced 2025-04-25 09:30:03 +00:00
Improve docs (#90)
* Add method * Remove unnecessary shadowed variable * Separate pages
This commit is contained in:
parent
49305f73dd
commit
a3eb2cddc3
13 changed files with 203 additions and 193 deletions
|
@ -9,12 +9,24 @@ export default defineConfig({
|
||||||
// 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',
|
text: "API reference",
|
||||||
|
items: [
|
||||||
|
{ text: "jecs", link: "/api/jecs" },
|
||||||
|
{ text: "World", link: "/api/world" },
|
||||||
|
{ text: "Query", link: "/api/query" }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"/learn/": [
|
||||||
|
{
|
||||||
|
text: "Introduction",
|
||||||
items: [
|
items: [
|
||||||
{ text: 'Getting Started', link: '/overview/get-started' },
|
{ text: 'Getting Started', link: '/overview/get-started' },
|
||||||
{ text: 'First Jecs Project', link: '/overview/first-jecs-project' }
|
{ text: 'First Jecs Project', link: '/overview/first-jecs-project' }
|
||||||
|
@ -28,18 +40,15 @@ export default defineConfig({
|
||||||
{ text: 'Queries', link: '/concepts/queries' },
|
{ text: 'Queries', link: '/concepts/queries' },
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
|
||||||
text: 'References',
|
|
||||||
items: [
|
|
||||||
{ text: 'API Reference', link: '/api' },
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
text: "FAQ",
|
text: "FAQ",
|
||||||
items: [
|
items: [
|
||||||
{ text: 'How can I contribute?', link: '/faq/contributing' }
|
{ text: 'How can I contribute?', link: '/faq/contributing' }
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
|
||||||
|
],
|
||||||
|
"/contributing/": [
|
||||||
{
|
{
|
||||||
text: 'Contributing',
|
text: 'Contributing',
|
||||||
items: [
|
items: [
|
||||||
|
@ -48,7 +57,8 @@ export default defineConfig({
|
||||||
{ text: 'Submitting Pull Requests', link: '/contributing/pull-requests' },
|
{ text: 'Submitting Pull Requests', link: '/contributing/pull-requests' },
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
],
|
]
|
||||||
|
},
|
||||||
|
|
||||||
socialLinks: [
|
socialLinks: [
|
||||||
{ icon: 'github', link: 'https://github.com/vuejs/vitepress' }
|
{ icon: 'github', link: 'https://github.com/vuejs/vitepress' }
|
||||||
|
|
|
@ -1,3 +0,0 @@
|
||||||
## TODO
|
|
||||||
|
|
||||||
This is a TODO stub.
|
|
|
@ -1,3 +0,0 @@
|
||||||
## TODO
|
|
||||||
|
|
||||||
This is a TODO stub.
|
|
|
@ -1,3 +0,0 @@
|
||||||
## TODO
|
|
||||||
|
|
||||||
This is a TODO stub.
|
|
3
docs/learn/concepts/queries.md
Normal file
3
docs/learn/concepts/queries.md
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
## TODO
|
||||||
|
|
||||||
|
This is a TODO stub.
|
3
docs/learn/concepts/static-components.md
Normal file
3
docs/learn/concepts/static-components.md
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
## TODO
|
||||||
|
|
||||||
|
This is a TODO stub.
|
3
docs/learn/faq/contributing.md
Normal file
3
docs/learn/faq/contributing.md
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
## TODO
|
||||||
|
|
||||||
|
This is a TODO stub.
|
3
docs/learn/overview/first-jecs-project.md
Normal file
3
docs/learn/overview/first-jecs-project.md
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
## TODO
|
||||||
|
|
||||||
|
This is a TODO stub.
|
Before Width: | Height: | Size: 34 KiB After Width: | Height: | Size: 34 KiB |
Before Width: | Height: | Size: 3.9 KiB After Width: | Height: | Size: 3.9 KiB |
|
@ -1,3 +0,0 @@
|
||||||
## TODO
|
|
||||||
|
|
||||||
This is a TODO stub.
|
|
Loading…
Reference in a new issue