mirror of
https://github.com/chenasraf/simple-scaffold.git
synced 2026-05-18 01:29:09 +00:00
docs: reorganize file structure
This commit is contained in:
2
.github/workflows/docs.yml
vendored
2
.github/workflows/docs.yml
vendored
@@ -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
2
.gitignore
vendored
@@ -64,5 +64,5 @@ examples/test-output/**/*
|
||||
dist/
|
||||
.DS_Store
|
||||
tmp/
|
||||
docs-gen/
|
||||
docs/
|
||||
.nvmrc
|
||||
|
||||
10
README.md
10
README.md
@@ -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
|
||||
|
||||
|
||||
@@ -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)
|
||||
@@ -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",
|
||||
|
||||
Reference in New Issue
Block a user