Skip to content

Commit

Permalink
chore(site): scaffold basic docs pages
Browse files Browse the repository at this point in the history
  • Loading branch information
JamieMason committed Feb 15, 2023
1 parent 67f9adc commit 92d2f23
Show file tree
Hide file tree
Showing 52 changed files with 219 additions and 797 deletions.
5 changes: 4 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
**/*.md
CHANGELOG.md
coverage
DEPENDENCIES.md
dist
site/.docusaurus
site/build
12 changes: 8 additions & 4 deletions site/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Website

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern
static website generator.

### Installation

Expand All @@ -14,15 +15,17 @@ $ yarn
$ yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
This command starts a local development server and opens up a browser window.
Most changes are reflected live without having to restart the server.

### Build

```
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.
This command generates static content into the `build` directory and can be
served using any static contents hosting service.

### Deployment

Expand All @@ -38,4 +41,5 @@ Not using SSH:
$ GIT_USER=<Your GitHub username> yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
If you are using GitHub pages for hosting, this command is a convenient way to
build the website and push to the `gh-pages` branch.
12 changes: 0 additions & 12 deletions site/blog/2019-05-28-first-blog-post.md

This file was deleted.

44 changes: 0 additions & 44 deletions site/blog/2019-05-29-long-blog-post.md

This file was deleted.

20 changes: 0 additions & 20 deletions site/blog/2021-08-01-mdx-blog-post.mdx

This file was deleted.

Binary file not shown.
25 changes: 0 additions & 25 deletions site/blog/2021-08-26-welcome/index.md

This file was deleted.

17 changes: 0 additions & 17 deletions site/blog/authors.yml

This file was deleted.

1 change: 1 addition & 0 deletions site/blog/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Blog
4 changes: 4 additions & 0 deletions site/docs/config-option.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
id: config-option
title: --config
---
4 changes: 4 additions & 0 deletions site/docs/custom-types-config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
id: custom-types-config
title: customTypes
---
4 changes: 4 additions & 0 deletions site/docs/dependency-types-config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
id: dependency-types-config
title: dependencyTypes
---
4 changes: 4 additions & 0 deletions site/docs/filter-config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
id: filter-config
title: filter
---
4 changes: 4 additions & 0 deletions site/docs/filter-option.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
id: filter-option
title: --filter
---
4 changes: 4 additions & 0 deletions site/docs/fix-mismatches.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
id: fix-mismatches
title: fix-mismatches
---
4 changes: 4 additions & 0 deletions site/docs/format.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
id: format
title: format
---
4 changes: 4 additions & 0 deletions site/docs/indent-config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
id: indent-config
title: indent
---
4 changes: 4 additions & 0 deletions site/docs/indent-option.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
id: indent-option
title: --indent
---
6 changes: 6 additions & 0 deletions site/docs/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
id: installation
title: Installation
---

sdasdasd
47 changes: 0 additions & 47 deletions site/docs/intro.md

This file was deleted.

4 changes: 4 additions & 0 deletions site/docs/lint-semver-ranges.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
id: lint-semver-ranges
title: lint-semver-ranges
---
4 changes: 4 additions & 0 deletions site/docs/list-mismatches.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
id: list-mismatches
title: list-mismatches
---
7 changes: 7 additions & 0 deletions site/docs/list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
id: list
title: list
---

x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x
x x x x x x x x x x x x x x x x x x x x x x x x
4 changes: 4 additions & 0 deletions site/docs/semver-groups-config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
id: semver-groups-config
title: semverGroups
---
4 changes: 4 additions & 0 deletions site/docs/semver-range-config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
id: semver-range-config
title: semverRange
---
4 changes: 4 additions & 0 deletions site/docs/semver-range-option.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
id: semver-range-option
title: --semverRange
---
4 changes: 4 additions & 0 deletions site/docs/set-semver-ranges.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
id: set-semver-ranges
title: set-semver-ranges
---
4 changes: 4 additions & 0 deletions site/docs/sort-az-config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
id: sort-az-config
title: sortAz
---
4 changes: 4 additions & 0 deletions site/docs/sort-first-config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
id: sort-first-config
title: sortFirst
---
4 changes: 4 additions & 0 deletions site/docs/source-config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
id: source-config
title: source
---
4 changes: 4 additions & 0 deletions site/docs/source-option.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
id: source-option
title: --source
---
8 changes: 0 additions & 8 deletions site/docs/tutorial-basics/_category_.json

This file was deleted.

23 changes: 0 additions & 23 deletions site/docs/tutorial-basics/congratulations.md

This file was deleted.

34 changes: 0 additions & 34 deletions site/docs/tutorial-basics/create-a-blog-post.md

This file was deleted.

0 comments on commit 92d2f23

Please sign in to comment.