docs: reorganize file structure

This commit is contained in:
Chen Asraf
2023-04-25 10:08:04 +03:00
committed by Chen Asraf
parent 873fa77c9a
commit f41ebfb1d0
10 changed files with 15 additions and 15 deletions

View File

@@ -17,4 +17,4 @@ jobs:
- uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs-gen
publish_dir: ./docs

2
.gitignore vendored
View File

@@ -64,5 +64,5 @@ examples/test-output/**/*
dist/
.DS_Store
tmp/
docs-gen/
docs/
.nvmrc

View File

@@ -76,11 +76,11 @@ export default PageWrapper: React.FC = (props) => {
See full documentation [here](https://chenasraf.github.io/simple-scaffold).
- [Command Line Interface (CLI) usage](https://chenasraf.github.io/simple-scaffold/pages/docs/cli.html)
- [Node.js usage](https://chenasraf.github.io/simple-scaffold/pages/docs/node.md)
- [Templates](https://chenasraf.github.io/simple-scaffold/pages/docs/templates.md)
- [Configuration Files](https://chenasraf.github.io/simple-scaffold/pages/docs/configuration_files.md)
- [Migrating 0.x to v1.x](https://chenasraf.github.io/simple-scaffold/pages/docs/migration.md)
- [Command Line Interface (CLI) usage](https://chenasraf.github.io/simple-scaffold/pages/cli.html)
- [Node.js usage](https://chenasraf.github.io/simple-scaffold/pages/node.html)
- [Templates](https://chenasraf.github.io/simple-scaffold/pages/templates.html)
- [Configuration Files](https://chenasraf.github.io/simple-scaffold/pages/configuration_files.html)
- [Migrating 0.x to v1.x](https://chenasraf.github.io/simple-scaffold/pages/migration.html)
## Contributing

View File

@@ -1,7 +1,7 @@
See full documentation [here](https://chenasraf.github.io/simple-scaffold).
- [Command Line Interface (CLI) usage](https://chenasraf.github.io/simple-scaffold/pages/docs/cli.html)
- [Node.js usage](https://chenasraf.github.io/simple-scaffold/pages/docs/node.md)
- [Templates](https://chenasraf.github.io/simple-scaffold/pages/docs/templates.md)
- [Configuration Files](https://chenasraf.github.io/simple-scaffold/pages/docs/configuration_files.md)
- [Migrating 0.x to v1.x](https://chenasraf.github.io/simple-scaffold/pages/docs/migration.md)
- [Command Line Interface (CLI) usage](https://chenasraf.github.io/simple-scaffold/pages/cli.html)
- [Node.js usage](https://chenasraf.github.io/simple-scaffold/pages/node.html)
- [Templates](https://chenasraf.github.io/simple-scaffold/pages/templates.html)
- [Configuration Files](https://chenasraf.github.io/simple-scaffold/pages/configuration_files.html)
- [Migrating 0.x to v1.x](https://chenasraf.github.io/simple-scaffold/pages/migration.html)

View File

@@ -15,7 +15,7 @@
"media": "media",
"githubPages": true,
"entryPointStrategy": "expand",
"out": "docs-gen",
"out": "docs",
"excludePrivate": true,
"excludeProtected": true,
"excludeInternal": true,
@@ -31,12 +31,12 @@
"logLevel": "Verbose",
"pluginPages": {
"logLevel": "Verbose",
"source": "docs",
"pages": [
{
"name": "Configuration",
"source": "README.md",
"childrenDir": "./docs",
"childrenDir": "./pages",
"childrenOutputDir": "./",
"children": [
{
"name": "CLI usage",