mirror of
https://github.com/discordeno/discordeno.git
synced 2026-07-21 13:42:53 +00:00
chore: move architecture to new docs (#3274)
* chore: move architecture to new docs * chore: move api reference * chore: faster local build * fix: env
This commit is contained in:
+8
-8
@@ -21,14 +21,14 @@ proxies/*/.yarn/*
|
||||
!proxies/*/.yarn/releases
|
||||
!proxies/*/.yarn/sdks
|
||||
!proxies/*/.yarn/versions
|
||||
site/docs/generated/classes
|
||||
site/docs/generated/enums
|
||||
site/docs/generated/interfaces
|
||||
site/docs/generated/modules
|
||||
website/docs/generated/classes/*.md
|
||||
website/docs/generated/enums/*.md
|
||||
website/docs/generated/interfaces/*.md
|
||||
website/docs/generated/modules/*.md
|
||||
site/api_reference/generated/classes
|
||||
site/api_reference/generated/enums
|
||||
site/api_reference/generated/interfaces
|
||||
site/api_reference/generated/modules
|
||||
website/api_reference/generated/classes/*.md
|
||||
website/api_reference/generated/enums/*.md
|
||||
website/api_reference/generated/interfaces/*.md
|
||||
website/api_reference/generated/modules/*.md
|
||||
website/.yarn/
|
||||
# testing
|
||||
coverage
|
||||
|
||||
+1
-1
@@ -3,7 +3,7 @@
|
||||
"entryPointStrategy": "packages",
|
||||
"entryPoints": ["packages/bot", "packages/gateway", "packages/rest", "packages/types", "packages/utils"],
|
||||
"skipErrorChecking": true,
|
||||
"out": "./website/docs/generated/",
|
||||
"out": "./website/api_reference/generated/",
|
||||
"cleanOutputDir": false,
|
||||
"plugin": ["typedoc-plugin-markdown"],
|
||||
"commentStyle": "all"
|
||||
|
||||
@@ -98,6 +98,13 @@ const config = {
|
||||
label: 'Tutorial',
|
||||
docsPluginId: 'tutorial',
|
||||
},
|
||||
{
|
||||
type: 'docSidebar',
|
||||
sidebarId: 'api_reference',
|
||||
position: 'left',
|
||||
label: 'API Reference',
|
||||
docsPluginId: 'api_reference',
|
||||
},
|
||||
{ to: '/blog', label: 'Blog', position: 'left' },
|
||||
{
|
||||
href: 'https://discord.gg/ddeno',
|
||||
@@ -161,6 +168,27 @@ const config = {
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
title: 'API Reference',
|
||||
items: [
|
||||
{
|
||||
label: 'Classes',
|
||||
to: '/api_reference/category/classes-3',
|
||||
},
|
||||
{
|
||||
label: 'Enums',
|
||||
to: '/api_reference/category/enums-3',
|
||||
},
|
||||
{
|
||||
label: 'Interfaces',
|
||||
to: '/api_reference/category/interfaces-3',
|
||||
},
|
||||
{
|
||||
label: 'Modules',
|
||||
to: '/api_reference/category/modules-3',
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
title: 'Community',
|
||||
items: [
|
||||
@@ -215,15 +243,26 @@ const config = {
|
||||
editUrl: 'https://github.com/discordeno/discordeno/tree/main/site/',
|
||||
},
|
||||
],
|
||||
[
|
||||
'@docusaurus/plugin-content-docs',
|
||||
/** @type {import('@docusaurus/plugin-content-docs').Options} */
|
||||
{
|
||||
id: 'api_reference',
|
||||
path: 'api_reference',
|
||||
routeBasePath: 'api_reference',
|
||||
sidebarPath: require.resolve('./sidebars.js'),
|
||||
editUrl: 'https://github.com/discordeno/discordeno/tree/main/site/',
|
||||
},
|
||||
],
|
||||
[
|
||||
require.resolve('@easyops-cn/docusaurus-search-local'),
|
||||
{
|
||||
indexDocs: true,
|
||||
indexPages: true,
|
||||
docsRouteBasePath: ['/docs', '/tutorial'],
|
||||
docsRouteBasePath: ['/docs', '/tutorial', 'api_reference'],
|
||||
language: ['en'],
|
||||
hashed: true,
|
||||
docsDir: ['docs', 'tutorial'],
|
||||
docsDir: ['docs', 'tutorial', 'api_reference'],
|
||||
blogDir: [],
|
||||
removeDefaultStopWordFilter: true,
|
||||
highlightSearchTermsOnTargetPage: true,
|
||||
|
||||
@@ -17,6 +17,7 @@ const sidebars = {
|
||||
tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }],
|
||||
tutorial: [{ type: 'autogenerated', dirName: '.' }],
|
||||
old_docs: [{ type: 'autogenerated', dirName: '.' }],
|
||||
api_reference: [{ type: 'autogenerated', dirName: '.' }],
|
||||
// But you can create a sidebar manually
|
||||
/*
|
||||
tutorialSidebar: [
|
||||
|
||||
@@ -9,7 +9,7 @@ module.exports = function (context, options) {
|
||||
return {
|
||||
name: 'webpack-docusaurus-plugin',
|
||||
configureWebpack(config, isServer, utils) {
|
||||
const cacheOptions = { cache: false }
|
||||
const cacheOptions = { cache: process.env.CI !== 'true' }
|
||||
|
||||
const minimizer = new TerserPlugin({
|
||||
minify: TerserPlugin.esbuildMinify,
|
||||
|
||||
Reference in New Issue
Block a user