From b3f3b7d5e38d6f995f57a8f5ee484fd69cbd0ef3 Mon Sep 17 00:00:00 2001 From: Kor Dwarshuis Date: Mon, 27 Jan 2025 12:46:42 +0100 Subject: [PATCH] =?UTF-8?q?Make=20=E2=80=9Cinstallation=E2=80=9D=20a=20con?= =?UTF-8?q?tainer=20for=20sub=20menus?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...tallation.md => differences-between-os.md} | 80 +------------------ docs/getting-started/github-token.md | 2 +- .../installation/_category_.json | 8 ++ .../installation/installation.md | 49 ++++++++++++ 4 files changed, 60 insertions(+), 79 deletions(-) rename docs/getting-started/{installation.md => differences-between-os.md} (59%) create mode 100644 docs/getting-started/installation/_category_.json create mode 100644 docs/getting-started/installation/installation.md diff --git a/docs/getting-started/installation.md b/docs/getting-started/differences-between-os.md similarity index 59% rename from docs/getting-started/installation.md rename to docs/getting-started/differences-between-os.md index f55777f8..0e7b876f 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/differences-between-os.md @@ -1,84 +1,8 @@ --- -sidebar_position: 1 +sidebar_position: 5 --- -# Installation - -Get started by **creating a new Spec-Up-T installation**. - - - -## Create a new Spec-Up-T installation - -### Let's create - -Make sure you are in the directory where you want to install Spec-Up-T. A new subdirectory will be created with **your chosen name**, and the Spec-Up-T files will be placed in this subdirectory. - -```bash -npx create-spec-up-t my-spec-up-t-website -``` - -*my-spec-up-t-website* can be anything you want it to be, that will **your chosen name** (however, it is recommended to not use spaces or special characters in directory names). - -You can also omit the last part: - -```bash -npx create-spec-up-t -``` - -If you omit `my-spec-up-t-website`, a default directory name, namely `spec-up-t-boilerplate,` is used. - -Sometimes, you want to force the latest version to be installed. Then you can do the following: - -```bash -npx create-spec-up-t@latest my-spec-up-t-website -``` - -You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. It should work on any operating system (not tested yet). - -### Result - -You should now have a directory called `my-spec-up-t-website` (or `spec-up-t-boilerplate` if you did not specify a name) with a subdirectory called `spec/`. You will find markdown files and another subdirectory, `terms-definitions` containing markdown files containing some sample content. - -What you don't have yet is the following: - -- a `docs` directory with a sample `index.html` file (which is the actual specification file that is the goal of it all). - -How to do this, go to the [Command Line Menu](../user-interface-overview/command-line-menu.md). - -### Add repo to Github - -You should push your new specification (i.e. the sample content) to a GitHub repo. - -These are the steps to take: - -#### Edit `specs.json` - -Change this entry in `specs.json`: - -```json -"source": { - "host": "github", - "account": "blockchainbird", - "repo": "spec-up-t-starter-pack" -} -``` - -to the correct information: - -```json -"source": { - "host": "github", - "account": "your-account", - "repo": "your-repo" -} -``` - -These are the host (GitHub), your GitHub account name, and the repo name of the repo you are about to push. - -#### Commit and Push repo to GitHub - -Now, commit your changes and push the repo to GitHub. Use the command line or your preferred way to do this. +# Different Operating Systems ## Difference between MacOS and Windows or Linux instructions diff --git a/docs/getting-started/github-token.md b/docs/getting-started/github-token.md index ecebc369..177446b2 100644 --- a/docs/getting-started/github-token.md +++ b/docs/getting-started/github-token.md @@ -1,5 +1,5 @@ --- -sidebar_position: 90 +sidebar_position: 4 --- # GitHub Personal Access Token (PAT) diff --git a/docs/getting-started/installation/_category_.json b/docs/getting-started/installation/_category_.json new file mode 100644 index 00000000..721e1c18 --- /dev/null +++ b/docs/getting-started/installation/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Installation", + "position": 1, + "link": { + "type": "generated-index", + "description": "Installation." + } +} \ No newline at end of file diff --git a/docs/getting-started/installation/installation.md b/docs/getting-started/installation/installation.md new file mode 100644 index 00000000..c3f9b7a6 --- /dev/null +++ b/docs/getting-started/installation/installation.md @@ -0,0 +1,49 @@ +--- +sidebar_position: 1 +--- + +# Local Installation + +Get started by **creating a new Spec-Up-T installation**. + + + +## Create a new Spec-Up-T installation + +### Let's create + +Make sure you are in the directory where you want to install Spec-Up-T. A new subdirectory will be created with **your chosen name**, and the Spec-Up-T files will be placed in this subdirectory. + +```bash +npx create-spec-up-t my-spec-up-t-website +``` + +*my-spec-up-t-website* can be anything you want it to be, that will **your chosen name** (however, it is recommended to not use spaces or special characters in directory names). + +You can also omit the last part: + +```bash +npx create-spec-up-t +``` + +If you omit `my-spec-up-t-website`, a default directory name, namely `spec-up-t-boilerplate,` is used. + +Sometimes, you want to force the latest version to be installed. Then you can do the following: + +```bash +npx create-spec-up-t@latest my-spec-up-t-website +``` + +You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. It should work on any operating system (not tested yet). + +### Result + +You should now have a directory called `my-spec-up-t-website` (or `spec-up-t-boilerplate` if you did not specify a name) with a subdirectory called `spec/`. You will find markdown files and another subdirectory, `terms-definitions` containing markdown files containing some sample content. + +What you don't have yet is the following: + +- a `docs` directory with a sample `index.html` file (which is the actual specification file that is the goal of it all). + +How to do this, go to the [Command Line Menu](../../user-interface-overview/command-line-menu.md). + +Now [let's get this thing on GitHub](push-to-github.md). \ No newline at end of file