This repository has been archived by the owner on Nov 5, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
61 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,6 +18,26 @@ Like all front-end projects, this one is created within Node.js ecosystem. Layer | |
npm install d0xigen@latest | ||
``` | ||
|
||
Reference `package.json`: | ||
|
||
```json [package.json] | ||
{ | ||
"private": true, | ||
"dependencies": { | ||
"d0xigen": "^0.1.4" | ||
} | ||
} | ||
``` | ||
|
||
::alert{type="warning"} | ||
[Nuxt color mode 3.1.8](https://github.com/nuxt-modules/color-mode) is incompatible with just released Nuxt 3.4.0. So, if you have some troubles with color mode, install Nuxt 3.3.3. | ||
|
||
```bash | ||
npm install [email protected] -D | ||
``` | ||
|
||
:: | ||
|
||
## Usage | ||
|
||
_d0xigen_ is a [Nuxt 3 layer](https://nuxt.com/docs/getting-started/layers). So, you need to install Nuxt 3 first. I believe you can do it yourself. | ||
|
@@ -61,3 +81,44 @@ npx nuxt dev | |
``` | ||
|
||
That's it! You can start creating content. Create `content` folder for that and enjoy features of [Nuxt Content](https://content.nuxtjs.org/). | ||
## GitHub pages | ||
Reference action for GitHub pages deployment: | ||
```yaml [docs.yml] | ||
name: Publish Docs | ||
on: | ||
push: | ||
workflow_dispatch: | ||
jobs: | ||
build-and-deploy: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v1 | ||
- name: Use Node.js 16 | ||
uses: actions/setup-node@v3 | ||
with: | ||
node-version: 16 | ||
- name: Installing packages | ||
working-directory: ./.docs | ||
run: npm install | ||
- name: Build Nuxt 3 static site | ||
working-directory: ./.docs | ||
run: npx nuxi generate | ||
- name: Deploy to GitHub Pages | ||
uses: peaceiris/actions-gh-pages@v3 | ||
if: github.ref == 'refs/heads/master' | ||
with: | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
publish_dir: ./.docs/dist | ||
commit_message: 'Automatic deploy: ${{ github.event.head_commit.message }}' | ||
``` |