From f41ebfb1d043afafd7d36cba0eb83728078d9ced Mon Sep 17 00:00:00 2001 From: Chen Asraf Date: Tue, 25 Apr 2023 10:08:04 +0300 Subject: [PATCH] docs: reorganize file structure --- .github/workflows/docs.yml | 2 +- .gitignore | 2 +- README.md | 10 +++++----- {docs => pages}/README.md | 10 +++++----- {docs => pages}/cli.md | 0 {docs => pages}/configuration_files.md | 0 {docs => pages}/migration.md | 0 {docs => pages}/node.md | 0 {docs => pages}/templates.md | 0 typedoc.json | 6 +++--- 10 files changed, 15 insertions(+), 15 deletions(-) rename {docs => pages}/README.md (72%) rename {docs => pages}/cli.md (100%) rename {docs => pages}/configuration_files.md (100%) rename {docs => pages}/migration.md (100%) rename {docs => pages}/node.md (100%) rename {docs => pages}/templates.md (100%) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index ed9bddb..5697cad 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -17,4 +17,4 @@ jobs: - uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./docs-gen + publish_dir: ./docs diff --git a/.gitignore b/.gitignore index 9196c9c..b0b2585 100644 --- a/.gitignore +++ b/.gitignore @@ -64,5 +64,5 @@ examples/test-output/**/* dist/ .DS_Store tmp/ -docs-gen/ +docs/ .nvmrc diff --git a/README.md b/README.md index f6c3fa9..0b071c1 100644 --- a/README.md +++ b/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 diff --git a/docs/README.md b/pages/README.md similarity index 72% rename from docs/README.md rename to pages/README.md index 4918ac2..d40cfbb 100644 --- a/docs/README.md +++ b/pages/README.md @@ -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) diff --git a/docs/cli.md b/pages/cli.md similarity index 100% rename from docs/cli.md rename to pages/cli.md diff --git a/docs/configuration_files.md b/pages/configuration_files.md similarity index 100% rename from docs/configuration_files.md rename to pages/configuration_files.md diff --git a/docs/migration.md b/pages/migration.md similarity index 100% rename from docs/migration.md rename to pages/migration.md diff --git a/docs/node.md b/pages/node.md similarity index 100% rename from docs/node.md rename to pages/node.md diff --git a/docs/templates.md b/pages/templates.md similarity index 100% rename from docs/templates.md rename to pages/templates.md diff --git a/typedoc.json b/typedoc.json index e127400..3b46eab 100644 --- a/typedoc.json +++ b/typedoc.json @@ -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",