Skip to content

Commit

Permalink
Upgrade from vuepress to vitepress
Browse files Browse the repository at this point in the history
  • Loading branch information
jaylinski committed Sep 23, 2023
1 parent 13a2e2d commit 1e7f452
Show file tree
Hide file tree
Showing 157 changed files with 2,492 additions and 39,735 deletions.
12 changes: 0 additions & 12 deletions .babelrc

This file was deleted.

8 changes: 0 additions & 8 deletions .eslintignore

This file was deleted.

47 changes: 0 additions & 47 deletions .eslintrc.js

This file was deleted.

5 changes: 3 additions & 2 deletions .github/workflows/build-and-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ on:
push:
branches:
- master

jobs:
build-and-deploy:
runs-on: ubuntu-latest
Expand All @@ -13,9 +14,9 @@ jobs:
- uses: actions/checkout@v1
- uses: actions/setup-node@v1
with:
node-version: 16
node-version: '20'
- run: npm ci
- run: npm run test-and-build
- run: npm run docs:build

- name: Deploy to ${{ env.TARGET_URL }}
uses: peaceiris/actions-gh-pages@v3
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
- name: Setup Node.js
uses: actions/setup-node@v2
with:
node-version: '16'
node-version: '20'

- name: Install dependencies
run: npm ci
Expand Down
7 changes: 3 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
node_modules
target
.idea
/*.iml
/src/.vitepress/cache
/node_modules
/target
5 changes: 1 addition & 4 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
node_modules
target
.idea
!.vuepress
!.vitepress
/src/usage-examples/precompilation/example.precompiled.js
/src/usage-examples/precompilation/precompile-in-nodejs.output.js
/src/*/usage-examples/precompilation/example.precompiled.js
Expand Down
15 changes: 0 additions & 15 deletions .vscode/launch.json

This file was deleted.

23 changes: 0 additions & 23 deletions README.markdown

This file was deleted.

24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
[![CI](https://github.com/handlebars-lang/docs/actions/workflows/ci.yml/badge.svg)](https://github.com/handlebars-lang/docs/actions/workflows/ci.yml)

This is the repository for the Handlebars documentation site.

* Target-URL: https://handlebarsjs.com

# Why VitePress?

There are a lot of static page generators out there nowadays.
I have chosen [VitePress](https://vitepress.dev/) over other systems for several reasons:

* I like [vuejs](https://vuejs.org).
* VitePress builds fast loading static sites with modern PWA technologies.
* VitePress is centered around markdown, but leaves the opportunity to inject interactive parts if needed.
* VitePress has a simple predefined way of adapting stylesheets, which makes it easy to adapt colors from the
original site without rewriting the whole css
* The vuejs documentation site is build with VitePress, so it will hopefully be around for a while.

You can challenge me and propose other solutions, but you might be asked to help out if you do.

-- Nils

:rocket: :rocket:

Loading

0 comments on commit 1e7f452

Please sign in to comment.