Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(docsWeb): add docs for publish #587

Merged
merged 1 commit into from
May 27, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 46 additions & 2 deletions apps/scully-docs/src/assets/scully-routes.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,41 @@
"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",
"order": 900,
"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",
"order": 1900,
"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",
Expand All @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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"
},
{
Expand Down
2 changes: 1 addition & 1 deletion apps/scully-docs/src/docs/docs-routing.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ const routes: Routes = [
component: DocsComponent,
children: [
{ path: ':slug', component: DocPageComponent },
{ path: '**', redirectTo: 'getting-started' }
{ path: '**', component: DocPageComponent }
]
}
];
Expand Down
Empty file added demos/plugins/extra-plugin.ts
Empty file.
2 changes: 1 addition & 1 deletion docs/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Plugins - contentFolder
title: Plugins - IgnoredPlugin
order: 720
lang: en
---
Expand Down
6 changes: 6 additions & 0 deletions docs/plugins/jsonPlugin.md → docs/plugin/jsonPlugin.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: Plugins - JSONPlugin
order: 730
lang: en
---

# JSON Plugin

The JSON Plugin fetches data from API endpoints during route discovery.
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
6 changes: 3 additions & 3 deletions scully.scullyDocs.config.js → scully.scully-docs.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
6 changes: 3 additions & 3 deletions scully.scullyDocs.config.ts → scully.scully-docs.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down