From 89f147e7da12c4623752c4ea5188c3d1ec1bab36 Mon Sep 17 00:00:00 2001 From: jorgeucano Date: Wed, 27 May 2020 10:21:37 -0300 Subject: [PATCH] docs(docsWeb): add docs for publish --- .../scully-docs/src/assets/scully-routes.json | 48 ++++++++++++++++++- .../src/docs/docs-routing.module.ts | 2 +- demos/plugins/extra-plugin.ts | 0 docs/features.md | 2 +- .../contentFolderPlugin.md | 0 docs/{plugins => plugin}/ingoredPlugin.md | 2 +- docs/{plugins => plugin}/jsonPlugin.md | 6 +++ package.json | 3 +- ....config.js => scully.scully-docs.config.js | 6 +-- ....config.ts => scully.scully-docs.config.ts | 6 +-- 10 files changed, 63 insertions(+), 12 deletions(-) create mode 100644 demos/plugins/extra-plugin.ts rename docs/{plugins => plugin}/contentFolderPlugin.md (100%) rename docs/{plugins => plugin}/ingoredPlugin.md (59%) rename docs/{plugins => plugin}/jsonPlugin.md (96%) rename scully.scullyDocs.config.js => scully.scully-docs.config.js (79%) rename scully.scullyDocs.config.ts => scully.scully-docs.config.ts (75%) diff --git a/apps/scully-docs/src/assets/scully-routes.json b/apps/scully-docs/src/assets/scully-routes.json index 232ecfe47..b3f46012e 100644 --- a/apps/scully-docs/src/assets/scully-routes.json +++ b/apps/scully-docs/src/assets/scully-routes.json @@ -7,6 +7,13 @@ "lang": "en", "sourceFile": "blog.md" }, + { + "route": "/docs/blog_es", + "title": "Crear un blog", + "order": 600, + "lang": "es", + "sourceFile": "blog_es.md" + }, { "route": "/docs/CODE_OF_CONDUCT", "title": "Code of Conduct", @@ -14,6 +21,13 @@ "lang": "en", "sourceFile": "CODE_OF_CONDUCT.md" }, + { + "route": "/docs/CODE_OF_CONDUCT_es", + "title": "Codigo de Conducta", + "order": 900, + "lang": "es", + "sourceFile": "CODE_OF_CONDUCT_es.md" + }, { "route": "/docs/features", "title": "Features", @@ -21,6 +35,13 @@ "lang": "en", "sourceFile": "features.md" }, + { + "route": "/docs/features_es", + "title": "Caracteristicas", + "order": 1900, + "lang": "es", + "sourceFile": "features_es.md" + }, { "route": "/docs/getting-started", "title": "Getting Started", @@ -42,6 +63,27 @@ "lang": "en", "sourceFile": "issues.md" }, + { + "route": "/docs/plugin/contentFolderPlugin", + "title": "Plugins - contentFolder", + "order": 710, + "lang": "en", + "sourceFile": "contentFolderPlugin.md" + }, + { + "route": "/docs/plugin/ingoredPlugin", + "title": "Plugins - IgnoredPlugin", + "order": 720, + "lang": "en", + "sourceFile": "ingoredPlugin.md" + }, + { + "route": "/docs/plugin/jsonPlugin", + "title": "Plugins - JSONPlugin", + "order": 730, + "lang": "en", + "sourceFile": "jsonPlugin.md" + }, { "route": "/docs/plugins", "title": "Plugins", @@ -84,6 +126,7 @@ "lang": "en", "sourceFile": "release-for-v8.md" }, + { "route": "/docs/roadmap", "sourceFile": "roadmap.md" }, { "route": "/docs/scully-cmd-line", "title": "Command Line Options", @@ -112,10 +155,11 @@ "sourceFile": "scully-provided-plugins.md" }, { - "route": "/docs/scully", - "title": "Scully Documentation", + "route": "/docs/Introduction", + "title": "Introduction", "order": 110, "lang": "en", + "slug": "Introduction", "sourceFile": "scully.md" }, { diff --git a/apps/scully-docs/src/docs/docs-routing.module.ts b/apps/scully-docs/src/docs/docs-routing.module.ts index 6669ba373..849341b0b 100644 --- a/apps/scully-docs/src/docs/docs-routing.module.ts +++ b/apps/scully-docs/src/docs/docs-routing.module.ts @@ -10,7 +10,7 @@ const routes: Routes = [ component: DocsComponent, children: [ { path: ':slug', component: DocPageComponent }, - { path: '**', redirectTo: 'getting-started' } + { path: '**', component: DocPageComponent } ] } ]; diff --git a/demos/plugins/extra-plugin.ts b/demos/plugins/extra-plugin.ts new file mode 100644 index 000000000..e69de29bb diff --git a/docs/features.md b/docs/features.md index 3d2cf9096..033ea0ece 100644 --- a/docs/features.md +++ b/docs/features.md @@ -18,7 +18,7 @@ its usage AS EASY AS POSSIBLE! - Transfer State Service - Utility Methods -[Plugins System](/docs/plugins): +[Plugins System](/docs/plugin): - Router Plugins - Render Plugins diff --git a/docs/plugins/contentFolderPlugin.md b/docs/plugin/contentFolderPlugin.md similarity index 100% rename from docs/plugins/contentFolderPlugin.md rename to docs/plugin/contentFolderPlugin.md diff --git a/docs/plugins/ingoredPlugin.md b/docs/plugin/ingoredPlugin.md similarity index 59% rename from docs/plugins/ingoredPlugin.md rename to docs/plugin/ingoredPlugin.md index c33e58b8f..aec73fcd6 100644 --- a/docs/plugins/ingoredPlugin.md +++ b/docs/plugin/ingoredPlugin.md @@ -1,5 +1,5 @@ --- -title: Plugins - contentFolder +title: Plugins - IgnoredPlugin order: 720 lang: en --- diff --git a/docs/plugins/jsonPlugin.md b/docs/plugin/jsonPlugin.md similarity index 96% rename from docs/plugins/jsonPlugin.md rename to docs/plugin/jsonPlugin.md index b64a2b9b2..c1c59b653 100644 --- a/docs/plugins/jsonPlugin.md +++ b/docs/plugin/jsonPlugin.md @@ -1,3 +1,9 @@ +--- +title: Plugins - JSONPlugin +order: 730 +lang: en +--- + # JSON Plugin The JSON Plugin fetches data from API endpoints during route discovery. diff --git a/package.json b/package.json index 1ae6f3077..5f3792c2d 100644 --- a/package.json +++ b/package.json @@ -32,7 +32,8 @@ "jest:test": "npx jest", "changelog": "npx conventional-changelog -p scully -i ./CHANGELOG.md -s && git add ./CHANGELOG.md", "commit": "git add . && npx git-cz", - "commit:select": "npx git-cz" + "commit:select": "npx git-cz", + "docs:build": "rm -rf ./dist/static/doc-sites/* && nx run scully-docs:build && node ./dist/libs/scully/scully --project=scully-docs" }, "private": true, "dependencies": { diff --git a/scully.scullyDocs.config.js b/scully.scully-docs.config.js similarity index 79% rename from scully.scullyDocs.config.js rename to scully.scully-docs.config.js index 7a0ae1326..4a29576a6 100644 --- a/scully.scullyDocs.config.js +++ b/scully.scully-docs.config.js @@ -4,9 +4,9 @@ require('./demos/plugins/docs-link-update'); var scully_1 = require('@scullyio/scully'); scully_1.setPluginConfig('md', { enableSyntaxHighlighting: true }); exports.config = { - projectRoot: './ng-projects/scullyDocs/src', - projectName: 'scullyDocs', - outDir: './dist/static', + projectRoot: './apps/scully-docs/src', + projectName: 'scully-docs', + outDir: './dist/static/doc-sites', routes: { '/docs/:slug': { type: 'contentFolder', diff --git a/scully.scullyDocs.config.ts b/scully.scully-docs.config.ts similarity index 75% rename from scully.scullyDocs.config.ts rename to scully.scully-docs.config.ts index 8be76ec2c..cf38da669 100644 --- a/scully.scullyDocs.config.ts +++ b/scully.scully-docs.config.ts @@ -4,9 +4,9 @@ import { setPluginConfig } from '@scullyio/scully'; setPluginConfig('md', { enableSyntaxHighlighting: true }); exports.config = { - projectRoot: './ng-projects/scullyDocs/src', - projectName: 'scullyDocs', - outDir: './dist/doc-sites', + projectRoot: './apps/scully-docs/src', + projectName: 'scully-docs', + outDir: './dist/static/doc-sites', routes: { '/docs/:slug': { type: 'contentFolder',