Skip to content

Commit

Permalink
docs: Added the entirety of existing developer documentation
Browse files Browse the repository at this point in the history
- removed template files from the project starter
- restored some of the missing pages about setting up easy and full node
  • Loading branch information
gked committed Nov 5, 2024
1 parent ea159c7 commit db9ba5f
Show file tree
Hide file tree
Showing 74 changed files with 1,594 additions and 5,575 deletions.
9 changes: 7 additions & 2 deletions docs/.vuepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ import { shikiPlugin } from '@vuepress/plugin-shiki'
import { defaultTheme } from '@vuepress/theme-default'
import { defineUserConfig } from 'vuepress'
import { getDirname, path } from 'vuepress/utils'
import { mdEnhancePlugin } from 'vuepress-plugin-md-enhance'

import {
head,
navbarEn,
Expand Down Expand Up @@ -111,7 +113,6 @@ export default defineUserConfig({
prismjs: !isProd,
},
}),

// configure markdown
markdown: {
importCode: {
Expand All @@ -133,7 +134,11 @@ export default defineUserConfig({
},

// use plugins
plugins: [
plugins: [
mdEnhancePlugin({
// Enable mermaid
mermaid: true
}),
docsearchPlugin({
appId: '', // TODO appId
apiKey: '', // TODO apiKey
Expand Down
130 changes: 59 additions & 71 deletions docs/.vuepress/configs/navbar/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,98 +3,86 @@ import { VERSION } from '../meta.js'

export const navbarEn: NavbarOptions = [
{
text: 'Guide',
children: [
'/guide/introduction.md',
'/guide/getting-started.md',
'/guide/monetization/index.md',
'/guide/configuration.md',
'/guide/page.md',
'/guide/markdown.md',
'/guide/assets.md',
'/guide/i18n.md',
'/guide/deployment.md',
'/guide/theme.md',
'/guide/plugin.md',
'/guide/bundler.md',
'/guide/migration.md',
'/guide/troubleshooting.md',
],
text: 'Get Started',
link: '/en/get-started.md',
},
{
text: 'Monetization',
link: '/en/monetization/get-started-monetization.md',
},
{
text: 'Developers',
text: 'Developer Docs',
children: [
{
text: 'Core',
text: 'Platform Overview',
children: [
{
text: 'CLI',
link: '/reference/cli.html',
},
'/reference/config.md',
'/reference/frontmatter.md',
'/reference/components.md',
'/reference/plugin-api.md',
'/reference/theme-api.md',
'/reference/client-api.md',
'/reference/node-api.md',
'/en/dev-docs/get-started-dev.md',
'/en/CONTRIBUTING.md',
],
},
{
text: 'Bundlers',
text: 'MiniApps',
children: [
'/reference/bundler/vite.md',
'/reference/bundler/webpack.md',
'/en/dev-docs/mini-apps.md',
],
},
{
text: 'Ecosystem',
children: [
{
text: 'Default Theme',
link: 'https://ecosystem.vuejs.press/themes/default/',
},
{
text: 'Plugins',
link: 'https://ecosystem.vuejs.press/plugins/',
},
],
},
],
},

{
text: 'Learn More',
children: [
{
text: 'Advanced',
text: 'Barteron',
children: [
'/advanced/architecture.md',
'/advanced/plugin.md',
'/advanced/theme.md',
{
text: 'Cookbook',
link: '/advanced/cookbook/',
},
'/en/dev-docs/barteron-app.md',
],
},
{
text: 'Resources',
text: 'Node Maintenance',
children: [
{
text: 'Ecosystem',
link: 'https://ecosystem.vuejs.press/',
},
{
text: 'MarketPlace',
link: 'https://marketplace.vuejs.press',
},
{
text: 'Contributing Guide',
link: 'https://github.com/vuepress/core/blob/main/CONTRIBUTING.md',
text: 'Full Node Setup',
link: '/en/dev-docs/full-node-setup.md',
},
],
},
],
},
{
text: 'User Docs',
children: [
'/en/get-started.md',
'en/user-docs/easy-node-setup.md',
],
},

// {
// text: 'User Docs',
// children: [
// {
// text: 'Advanced',
// children: [
// '/advanced/architecture.md',
// '/advanced/plugin.md',
// '/advanced/theme.md',
// {
// text: 'Cookbook',
// link: '/advanced/cookbook/',
// },
// ],
// },
// {
// text: 'Resources',
// children: [
// {
// text: 'Ecosystem',
// link: 'https://ecosystem.vuejs.press/',
// },
// {
// text: 'MarketPlace',
// link: 'https://marketplace.vuejs.press',
// },
// {
// text: 'Contributing Guide',
// link: 'https://github.com/vuepress/core/blob/main/CONTRIBUTING.md',
// },
// ],
// },
// ],
// },
] as NavbarOptions
139 changes: 81 additions & 58 deletions docs/.vuepress/configs/sidebar/en.ts
Original file line number Diff line number Diff line change
@@ -1,80 +1,103 @@
import type { SidebarOptions } from '@vuepress/theme-default'

export const sidebarEn: SidebarOptions = {
'/guide/': [
'/en': [
{
text: 'Guide',
children: [
'/guide/introduction.md',
'/guide/getting-started.md',
'/guide/monetization/index.md',
'/guide/configuration.md',
'/guide/page.md',
'/guide/markdown.md',
'/guide/assets.md',
'/guide/i18n.md',
'/guide/deployment.md',
'/guide/theme.md',
'/guide/plugin.md',
'/guide/bundler.md',
'/guide/migration.md',
'/guide/troubleshooting.md',
],
text: 'Get Started',
collapsible: true,
link: 'get-started.md',
},
],
'/reference/': [
{
text: 'Core',
collapsible: true,
text: 'Ways to Monetize',
children: [
'/reference/cli.md',
'/reference/config.md',
'/reference/frontmatter.md',
'/reference/components.md',
'/reference/plugin-api.md',
'/reference/theme-api.md',
'/reference/client-api.md',
'/reference/node-api.md',
'monetization/get-started-monetization.md',
],
},
{
text: 'Bundlers',
children: ['/reference/bundler/vite.md', '/reference/bundler/webpack.md'],
},
{
text: 'Ecosystem',
text: 'User Documentation',
children: [
{
text: 'Default Theme',
link: 'https://ecosystem.vuejs.press/themes/default/',
},
{
text: 'Plugins',
link: 'https://ecosystem.vuejs.press/plugins/',
},
'user-docs/easy-node-setup.md',
],
},
],
'/advanced/': [
{
text: 'Advanced',
text: 'Developer Documentation',
collapsible: true,
children: [
'/advanced/architecture.md',
'/advanced/plugin.md',
'/advanced/theme.md',
'dev-docs/get-started-dev.md',
'dev-docs/mini-apps.md',
'dev-docs/barteron-app.md',
'dev-docs/full-node-setup.md',
],
},
{
text: 'Cookbook',
text: 'Contributing to Bastyon',
collapsible: true,
children: [
'/advanced/cookbook/README.md',
'/advanced/cookbook/usage-of-client-config.md',
'/advanced/cookbook/adding-extra-pages.md',
'/advanced/cookbook/making-a-theme-extendable.md',
'/advanced/cookbook/passing-data-to-client-code.md',
'/advanced/cookbook/markdown-and-vue-sfc.md',
'/advanced/cookbook/resolving-routes.md',
'CONTRIBUTING.md',
],
},
],
]
// '/en/monetization': [
// {
// text: 'Ways to Monetize',
// children: [
// 'get-started-monetization.md',
// ],
// },
// {
// text: 'Developer Documentation',
// collapsible: true,
// children: [
// '/dev-docs/get-started-dev',
// ],
// },
// ],
// 'en': [
// {
// text: 'Developer Documentation',
// collapsible: true,
// children: [
// '/dev-docs/get-started-dev',
// ],
// },
// {
// text: 'Bundlers',
// children: ['/reference/bundler/vite.md', '/reference/bundler/webpack.md'],
// },
// {
// text: 'Ecosystem',
// children: [
// {
// text: 'Default Theme',
// link: 'https://ecosystem.vuejs.press/themes/default/',
// },
// {
// text: 'Plugins',
// link: 'https://ecosystem.vuejs.press/plugins/',
// },
// ],
// },
// ],
// '/advanced/': [
// {
// text: 'Advanced',
// children: [
// '/advanced/architecture.md',
// '/advanced/plugin.md',
// '/advanced/theme.md',
// ],
// },
// {
// text: 'Cookbook',
// children: [
// '/advanced/cookbook/README.md',
// '/advanced/cookbook/usage-of-client-config.md',
// '/advanced/cookbook/adding-extra-pages.md',
// '/advanced/cookbook/making-a-theme-extendable.md',
// '/advanced/cookbook/passing-data-to-client-code.md',
// '/advanced/cookbook/markdown-and-vue-sfc.md',
// '/advanced/cookbook/resolving-routes.md',
// ],
// },
// ],
}
File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
36 changes: 0 additions & 36 deletions docs/advanced/architecture.md

This file was deleted.

10 changes: 0 additions & 10 deletions docs/advanced/cookbook/README.md

This file was deleted.

Loading

0 comments on commit db9ba5f

Please sign in to comment.