generated from sapphiredev/sapphire-template
-
-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- feat: start setting up the plugin for parsing - feat: start parsing classes - chore: add actual words - permalink: http://whatthecommit.com/3d6431a17a3b67e8b1341a2c6e4362f8 - chore: it's working! - permalink: http://whatthecommit.com/8d8c1f3903766b8ef27575d63115cac6 - feat: update framework json - fix: fixed rendering custom files with css - chore: update framework json to exclude externals - feat: setup parsing sapphire classes and do a lot of link fixing - refactor: switch to sapphire result - fix: remove replaceall for Node 14 compat - fix: actually remove replaceAll - fix: fixed css extraction regex - I thought I did this already - fix: fixed broken link on welcome page - chore: temporarily disable reporting broken links - feat: much stuff - change `classes` to `class` to match DJS - add `typedef` and `namespace` linking - fix linking of non-generic types - update guide urls to match `class` change - chore: bump deps - chore: i'll explain when you're older! - permalink: http://whatthecommit.com/91a07064bb814666919304a00161fc6c - chore: dope - permalink: http://whatthecommit.com/bab00ed1aa0abb17cce41f36deea1607 - chore: cleanup types - feat: add variant to typedefs - build: make it easier to debug - fix: partially fix link extraction - feat(docgen): add renderTypedef() - Moved parseSee() from /lib/renderer/renderClass.ts to /lib/renderer/utils.ts - Add /lib/renderer/renderTypedef.ts Which adds basic functionality in the website with things like title, description and extendedDescription - chore: sort ts interfaces in docgen output - chore: update doc types - refactor: completely refactor how links are resolved - fix: fixed links for `{@link` tags and propegate change to mdn and djs - fix: use `replace` instead of `replaceAll` - feat(docusaurus-discordjs-docgen): add functionality for enum and interface - style(docusaurus-discordjs-docgen): use Array#flat() for typedef - feat(docusaurus-discordjs-docgen): add constructor table functionality for classes - feat(docusaurus-discordjs-docgen): align table content to center - feat(docusaurus-discordjs-docgen): remove description column if all falsy - feat(docusaurus-discordjs-docgen): add properties functionality for classes - ci: add automatic vercel deploys workflow - chore(docusaurus-typedoc-json-parser): initial commit - chore(docusaurus-typedoc-json-parser): add doc fetching - chore(docusaurus-typedoc-json-parser): add sidebar rendering - fix(deps): update all non-major dependencies - fix(deps): update dependency typedoc-json-parser to ^5.2.0 - feat(docusaurus-typedoc-json-parser): add basic renderers - style(docusaurus-typedoc-json-parser): curly brackets and spacing - style(docusaurus-typedoc-json-parser): template literals - feat(docusaurus-typedoc-json-parser): add class extends and implements - feat(docusaurus-typedoc-json-parser): add link parsing for the local project - chore(docusaurus-typedoc-json-parser): add `start` script to bypass debugger - feat(docusaurus-typedoc-json-parser): add comment info for classes - chore: update dev deps
- Loading branch information
Showing
80 changed files
with
62,164 additions
and
18,506 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| name: Automatic Vercel Deploys | ||
|
|
||
| on: | ||
| # TODO: Enable pre-merge | ||
| # schedule: | ||
| # - cron: '30 3 * * *' | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| AutomaticVercelDeploy: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Trigger Vercel Deploy | ||
| run: curl -X POST ${VERCEL_DEPLOY_HOOK_URL} | ||
| env: | ||
| VERCEL_DEPLOY_HOOK_URL: ${{ secrets.VERCEL_DEPLOY_HOOK_URL }} |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| { | ||
| "configurations": [ | ||
| { | ||
| "type": "pwa-node", | ||
| "request": "launch", | ||
| "runtimeArgs": ["run-script", "debug"], | ||
| "name": "Debug Docgen", | ||
| "runtimeExecutable": "npm", | ||
| "skipFiles": ["<node_internals>/**", "node_modules/tslib/**"], | ||
| "internalConsoleOptions": "openOnSessionStart", | ||
| "cwd": "${workspaceFolder}/docusaurus-discordjs-docgen", | ||
| "console": "internalConsole", | ||
| "outputCapture": "std", | ||
| "outFiles": ["${workspaceFolder}/docusaurus-discordjs-docgen/dist/**/*.js"] | ||
| } | ||
| ] | ||
| } |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| { | ||
| "name": "docusaurus-discordjs-docgen", | ||
| "version": "0.0.1", | ||
| "description": "A Docusaurus v2 plugin to build API documentation based on @discordjs/ts-docgen output.", | ||
| "main": "dist/index.js", | ||
| "files": [ | ||
| "dist/" | ||
| ], | ||
| "scripts": { | ||
| "build": "tsc", | ||
| "watch": "tsc -w", | ||
| "debug": "node --inspect scripts/debug.mjs" | ||
| }, | ||
| "dependencies": { | ||
| "@sapphire/docusaurus-plugin-ts2esm2cjs": "^1.1.3", | ||
| "@sapphire/result": "^2.6.0", | ||
| "@sapphire/utilities": "^3.11.0", | ||
| "common-tags": "^1.8.2", | ||
| "css": "^3.0.0" | ||
| }, | ||
| "devDependencies": { | ||
| "@docusaurus/types": "2.1.0", | ||
| "@types/common-tags": "^1.8.1" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| import { fileURLToPath } from 'node:url'; | ||
| import parser from '../dist/index.js'; | ||
|
|
||
| const docusaurusDiscordjsDocgen = parser.default; | ||
|
|
||
| const siteDir = new URL('../../', import.meta.url); | ||
| const generatedFilesDir = new URL('.docusaurus/', siteDir); | ||
| const outDir = new URL('build/', siteDir); | ||
| const siteConfigPath = new URL('docusaurus.config.js', siteDir); | ||
|
|
||
| const docgenJsonFile = new URL('data/framework.json', siteDir); | ||
| const outDocs = new URL('docs/Documentation/sapphire-framework', siteDir); | ||
|
|
||
| docusaurusDiscordjsDocgen( | ||
| { | ||
| siteDir: fileURLToPath(siteDir), | ||
| generatedFilesDir: fileURLToPath(generatedFilesDir), | ||
| siteConfig: { | ||
| title: 'Sapphire', | ||
| url: 'https://sapphirejs.dev', | ||
| baseUrl: '/', | ||
| onBrokenLinks: 'warn', | ||
| onBrokenMarkdownLinks: 'warn', | ||
| onDuplicateRoutes: 'throw', | ||
| favicon: 'img/favicon.ico', | ||
| tagline: | ||
| 'Sapphire is a next-gen Discord bot framework for developers of all skill levels to make the best JavaScript/TypeScript based bots possible.', | ||
| organizationName: 'sapphiredev', | ||
| projectName: 'framework', | ||
| baseUrlIssueBanner: true, | ||
| i18n: { | ||
| defaultLocale: 'en', | ||
| locales: ['en'], | ||
| localeConfigs: {} | ||
| }, | ||
| staticDirectories: ['static'], | ||
| customFields: {}, | ||
| scripts: [], | ||
| stylesheets: [], | ||
| clientModules: [], | ||
| titleDelimiter: '|', | ||
| noIndex: false | ||
| }, | ||
| siteConfigPath: fileURLToPath(siteConfigPath), | ||
| outDir: fileURLToPath(outDir), | ||
| baseUrl: '/', | ||
| i18n: { | ||
| defaultLocale: 'en', | ||
| locales: ['en'], | ||
| currentLocale: 'en', | ||
| localeConfigs: { | ||
| en: { | ||
| label: 'English', | ||
| direction: 'ltr', | ||
| htmlLang: 'en' | ||
| } | ||
| } | ||
| }, | ||
| codeTranslations: {} | ||
| }, | ||
| { | ||
| id: 'framework', | ||
| docgenJsonFile: fileURLToPath(docgenJsonFile), | ||
| out: fileURLToPath(outDocs), | ||
| sidebar: { | ||
| categoryLabel: '@sapphire/framework', | ||
| position: 0 | ||
| } | ||
| } | ||
| ).loadContent(); |
Oops, something went wrong.