diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 701d46c..ff0c50b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -16,7 +16,7 @@ Steps to reproduce the behavior: 1. Prepare templates: - ```txt + ```text This is my {{ template }} ``` diff --git a/README.md b/README.md index 2bc521e..f1b5dbb 100644 --- a/README.md +++ b/README.md @@ -29,39 +29,14 @@ lifting for you and start building your projects faster and more efficiently tod -
- -
- Table of contents - -- [Install](#install) -- [Quick Start](#quick-start) -- [Documentation](#documentation) -- [Contributing](#contributing) - -
- --- -## Install - -You can either use it as a command line tool or import into your own code and run from there. - -```bash -# npm -npm install [-g] simple-scaffold -# yarn -yarn [global] add simple-scaffold -# run without installing -npx simple-scaffold@latest <...args> -``` - ## Quick Start The fastest way to get started is to use `npx` to immediately start a scaffold process. -Prepare any templates you want to use, e.g. in the directory `templates/component`, and use that in -the CLI args. Here is a simple example: +Prepare any templates you want to use - for example, in the directory `templates/component`; and use +that in the CLI args. Here is a simple example file: `templates/component/{{ psacalName name }}.tsx` @@ -99,6 +74,8 @@ export default PageWrapper: React.FC = (props) => { ## Documentation +See full documentation [here](https://casraf.dev/simple-scaffold). + - [Command Line Interface (CLI) usage](/docs/cli.md) - [Node.js usage](/docs/node.md) - [Templates](/docs/templates.md) diff --git a/docs/cli.md b/docs/cli.md index cb84385..1176939 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -3,7 +3,7 @@ The following is the help text from the `simple-scaffold` binary. To see this and more information anytime, add the `-h` or `--help` flag to your call, e.g. `npx simple-scaffold@latest -h`. -```txt +```text Usage: simple-scaffold [options] Create structured files based on templates. diff --git a/src/docs.css b/src/docs.css index 2a31df0..90c709f 100644 --- a/src/docs.css +++ b/src/docs.css @@ -1,7 +1,6 @@ .tsd-typography table { border-collapse: collapse; width: 100%; - box-sizing } .tsd-typography table td, @@ -10,32 +9,29 @@ border: 1px solid var(--color-accent); padding: 6px; } - -.tsd-typography h1 + table, -.tsd-typography h2 + table, -.tsd-typography h3 + table, -.tsd-typography h4 + table, -.tsd-typography h5 + table, -.tsd-typography h6 + table, - .tsd-typography h1 + pre, .tsd-typography h2 + pre, .tsd-typography h3 + pre, .tsd-typography h4 + pre, .tsd-typography h5 + pre, -.tsd-typography h6 + pre { +.tsd-typography h6 + pre, +/* */ +.tsd-typography h1 + table, +.tsd-typography h2 + table, +.tsd-typography h3 + table, +.tsd-typography h4 + table, +.tsd-typography h5 + table, +.tsd-typography h6 + table { margin-top: 1em; } - - .tsd-typography pre + a + h1, .tsd-typography pre + a + h2, .tsd-typography pre + a + h3, .tsd-typography pre + a + h4, .tsd-typography pre + a + h5, .tsd-typography pre + a + h6, - +/* */ .tsd-typography table + a + h1, .tsd-typography table + a + h2, .tsd-typography table + a + h3, @@ -44,3 +40,12 @@ .tsd-typography table + a + h6 { margin-top: 2em; } + +.tsd-index-accordion[data-key*="Configuration."] ul.tsd-nested-navigation, +.tsd-index-accordion[data-key*="Configuration."] .tsd-accordion-summary > svg { + display: none; +} + +.tsd-index-accordion[data-key*="Configuration."] { + margin-left: 0; +}