shayandrg
/
doc-init
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

installing nuxt-content

master
ShayanDRG 3 years ago
commit
3d6c75e585
13 changed files with 159 additions and 0 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 3
      .env.example
  2. 12
      .gitignore
  3. 27
      content/en/index.md
  4. 42
      content/en/setup.md
  5. 10
      content/settings.json
  6. 13
      docker-compose.yml
  7. 7
      nuxt.config.js
  8. 15
      package.json
  9. BIN
      static/icon.png
  10. 15
      static/logo-dark.svg
  11. 15
      static/logo-light.svg
  12. BIN
      static/preview-dark.png
  13. BIN
      static/preview.png

3
.env.example
View File

@ -0,0 +1,3 @@
# Create one with no scope selected on https://github.com/settings/tokens/new
GITHUB_TOKEN=

12
.gitignore
View File

@ -0,0 +1,12 @@
node_modules
*.iml
.idea
*.log*
.nuxt
.vscode
.DS_Store
coverage
dist
sw.*
.env
package-lock.json

27
content/en/index.md
View File

@ -0,0 +1,27 @@
---
title: Introduction
description: ''
position: 1
category: ''
features:
- Feature 1
- Feature 2
- Feature 3
---
<img src="/preview.png" class="light-img" width="1280" height="640" alt=""/>
<img src="/preview-dark.png" class="dark-img" width="1280" height="640" alt=""/>
[Module]() for [NuxtJS](https://nuxtjs.org).
<alert type="success">
Your documentation has been created successfully!
</alert>
## Features
<list :items="features"></list>
<p class="flex items-center">Enjoy light and dark mode:&nbsp;<app-color-switcher class="inline-flex ml-2"></app-color-switcher></p>

42
content/en/setup.md
View File

@ -0,0 +1,42 @@
---
title: Setup
description: ''
position: 2
category: Guide
---
Check the [Nuxt.js documentation](https://nuxtjs.org/guides/configuration-glossary/configuration-modules) for more information about installing and using modules in Nuxt.js.
## Installation
Add `@nuxtjs/xxx` dependency to your project:
<code-group>
<code-block label="Yarn" active>
```bash
yarn add @nuxtjs/xxx
```
</code-block>
<code-block label="NPM">
```bash
npm install @nuxtjs/xxx
```
</code-block>
</code-group>
Then, add `@nuxtjs/xxx` to the `modules` section of `nuxt.config.js`:
```js[nuxt.config.js]
{
modules: [
'@nuxtjs/xxx'
],
xxx: {
// Options
}
}
```

10
content/settings.json
View File

@ -0,0 +1,10 @@
{
"title": "Nuxt Content",
"url": "",
"logo": {
"light": "/logo-light.svg",
"dark": "/logo-dark.svg"
},
"github": "doc-init",
"twitter": "@nuxt_js"
}

13
docker-compose.yml
View File

@ -0,0 +1,13 @@
version: '3'
services:
nuxt:
image: node:lts
user: $UID:$GID
ports:
- '3000:3000'
volumes:
- '.:/srv'
working_dir: /srv
command: "npm run dev"
# command: bash -c "npm run build; npm run start"
# command: bash -c "npm install; npm audit fix; npm run build; npm run start"

7
nuxt.config.js
View File

@ -0,0 +1,7 @@
import theme from '@nuxt/content-theme-docs'
export default theme({
docs: {
primaryColor: '#E24F55'
}
})

15
package.json
View File

@ -0,0 +1,15 @@
{
"name": "doc-init",
"version": "1.0.0",
"private": true,
"scripts": {
"dev": "nuxt",
"build": "nuxt build",
"start": "nuxt start",
"generate": "nuxt generate"
},
"dependencies": {
"@nuxt/content-theme-docs": "^0.11.0",
"nuxt": "^2.15.8"
}
}

BIN
static/icon.png
View File

Binary file not shown.
Side by Side

After

Width: 512  |  Height: 512  |  Size: 11 KiB

15
static/logo-dark.svg
View File

@ -0,0 +1,15 @@
<svg width="219" height="40" viewBox="0 0 219 40" fill="none" xmlns="http://www.w3.org/2000/svg">
<g clip-path="url(#clip0)">
<path d="M14.6997 15.2543C15.553 16.7324 14.4864 18.58 12.7798 18.58H2.22023C0.513642 18.58 -0.552975 16.7323 0.300319 15.2543L5.58009 6.10858C6.43338 4.63047 8.56662 4.63047 9.41991 6.10858L14.6997 15.2543Z" fill="#00CD81"/>
<path d="M17.5801 27.5285C18.4334 26.0505 20.5666 26.0505 21.4199 27.5285L26.6997 36.6733C27.553 38.1512 26.4864 39.9987 24.7798 39.9987H14.2202C12.5136 39.9987 11.447 38.1512 12.3003 36.6733L17.5801 27.5285Z" fill="#E6FAF2"/>
<path d="M21.4199 12.4702C20.5666 13.9482 18.4334 13.9482 17.5801 12.4702L12.3003 3.32539C11.447 1.84742 12.5136 0 14.2202 0H24.7798C26.4864 0 27.553 1.84742 26.6997 3.32539L21.4199 12.4702Z" fill="#007B4D"/>
<path d="M12.7798 22C14.4864 22 15.553 23.8476 14.6997 25.3257L9.41991 34.4714C8.56662 35.9495 6.43338 35.9495 5.58009 34.4714L0.300319 25.3257C-0.552975 23.8476 0.513642 22 2.22023 22H12.7798Z" fill="#99EBCD"/>
<path d="M39.82 28V14.112H42.984L43.264 16.464C43.6933 15.6427 44.3093 14.9893 45.112 14.504C45.9333 14.0187 46.8947 13.776 47.996 13.776C49.7133 13.776 51.048 14.3173 52 15.4C52.952 16.4827 53.428 18.0693 53.428 20.16V28H49.844V20.496C49.844 19.3013 49.6013 18.3867 49.116 17.752C48.6307 17.1173 47.8747 16.8 46.848 16.8C45.84 16.8 45.0093 17.1547 44.356 17.864C43.7213 18.5733 43.404 19.5627 43.404 20.832V28H39.82ZM70.2392 14.112V28H67.0752L66.7952 25.648C66.3658 26.4693 65.7405 27.1227 64.9192 27.608C64.1165 28.0933 63.1645 28.336 62.0632 28.336C60.3458 28.336 59.0112 27.7947 58.0592 26.712C57.1072 25.6293 56.6312 24.0427 56.6312 21.952V14.112H60.2152V21.616C60.2152 22.8107 60.4578 23.7253 60.9432 24.36C61.4285 24.9947 62.1845 25.312 63.2112 25.312C64.2192 25.312 65.0405 24.9573 65.6752 24.248C66.3285 23.5387 66.6552 22.5493 66.6552 21.28V14.112H70.2392ZM72.5743 28L77.6143 21.056L72.5743 14.112H76.4103L79.9383 19.04L83.4383 14.112H87.3023L82.2343 21.056L87.3023 28H83.4383L79.9383 23.072L76.4103 28H72.5743ZM95.7736 28C94.3176 28 93.151 27.6453 92.2736 26.936C91.3963 26.2267 90.9576 24.9667 90.9576 23.156V17.108H88.5776V14.112H90.9576L91.3776 10.388H94.5416V14.112H98.2936V17.108H94.5416V23.184C94.5416 23.856 94.6816 24.3227 94.9616 24.584C95.2603 24.8267 95.7643 24.948 96.4736 24.948H98.2096V28H95.7736ZM100.195 31.108L107.195 6.244H110.695L103.667 31.108H100.195Z" fill="#E6FAF2"/>
<path d="M119.96 28.336C118.541 28.336 117.291 28.028 116.208 27.412C115.125 26.796 114.267 25.9373 113.632 24.836C113.016 23.7347 112.708 22.4747 112.708 21.056C112.708 19.6373 113.016 18.3773 113.632 17.276C114.267 16.1747 115.125 15.316 116.208 14.7C117.291 14.084 118.541 13.776 119.96 13.776C121.733 13.776 123.227 14.2427 124.44 15.176C125.653 16.0907 126.428 17.36 126.764 18.984H122.984C122.797 18.312 122.424 17.7893 121.864 17.416C121.323 17.024 120.679 16.828 119.932 16.828C118.943 16.828 118.103 17.2013 117.412 17.948C116.721 18.6947 116.376 19.7307 116.376 21.056C116.376 22.3813 116.721 23.4173 117.412 24.164C118.103 24.9107 118.943 25.284 119.932 25.284C120.679 25.284 121.323 25.0973 121.864 24.724C122.424 24.3507 122.797 23.8187 122.984 23.128H126.764C126.428 24.696 125.653 25.956 124.44 26.908C123.227 27.86 121.733 28.336 119.96 28.336ZM136.609 28.336C135.265 28.336 134.052 28.028 132.969 27.412C131.905 26.796 131.056 25.9467 130.421 24.864C129.805 23.7627 129.497 22.4933 129.497 21.056C129.497 19.6187 129.814 18.3587 130.449 17.276C131.084 16.1747 131.933 15.316 132.997 14.7C134.08 14.084 135.293 13.776 136.637 13.776C137.962 13.776 139.157 14.084 140.221 14.7C141.304 15.316 142.153 16.1747 142.769 17.276C143.404 18.3587 143.721 19.6187 143.721 21.056C143.721 22.4933 143.404 23.7627 142.769 24.864C142.153 25.9467 141.304 26.796 140.221 27.412C139.138 28.028 137.934 28.336 136.609 28.336ZM136.609 25.228C137.542 25.228 138.354 24.8827 139.045 24.192C139.736 23.4827 140.081 22.4373 140.081 21.056C140.081 19.6747 139.736 18.6387 139.045 17.948C138.354 17.2387 137.552 16.884 136.637 16.884C135.685 16.884 134.864 17.2387 134.173 17.948C133.501 18.6387 133.165 19.6747 133.165 21.056C133.165 22.4373 133.501 23.4827 134.173 24.192C134.864 24.8827 135.676 25.228 136.609 25.228ZM146.925 28V14.112H150.089L150.369 16.464C150.799 15.6427 151.415 14.9893 152.217 14.504C153.039 14.0187 154 13.776 155.101 13.776C156.819 13.776 158.153 14.3173 159.105 15.4C160.057 16.4827 160.533 18.0693 160.533 20.16V28H156.949V20.496C156.949 19.3013 156.707 18.3867 156.221 17.752C155.736 17.1173 154.98 16.8 153.953 16.8C152.945 16.8 152.115 17.1547 151.461 17.864C150.827 18.5733 150.509 19.5627 150.509 20.832V28H146.925ZM170.149 28C168.693 28 167.526 27.6453 166.649 26.936C165.771 26.2267 165.333 24.9667 165.333 23.156V17.108H162.953V14.112H165.333L165.753 10.388H168.917V14.112H172.669V17.108H168.917V23.184C168.917 23.856 169.057 24.3227 169.337 24.584C169.635 24.8267 170.139 24.948 170.849 24.948H172.585V28H170.149ZM182.138 28.336C180.738 28.336 179.497 28.0373 178.414 27.44C177.332 26.8427 176.482 26.0027 175.866 24.92C175.25 23.8373 174.942 22.5867 174.942 21.168C174.942 19.7307 175.241 18.452 175.838 17.332C176.454 16.212 177.294 15.344 178.358 14.728C179.441 14.0933 180.71 13.776 182.166 13.776C183.529 13.776 184.733 14.0747 185.778 14.672C186.824 15.2693 187.636 16.0907 188.214 17.136C188.812 18.1627 189.11 19.3107 189.11 20.58C189.11 20.7853 189.101 21 189.082 21.224C189.082 21.448 189.073 21.6813 189.054 21.924H178.498C178.573 23.0067 178.946 23.856 179.618 24.472C180.309 25.088 181.14 25.396 182.11 25.396C182.838 25.396 183.445 25.2373 183.93 24.92C184.434 24.584 184.808 24.1547 185.05 23.632H188.69C188.429 24.5093 187.99 25.312 187.374 26.04C186.777 26.7493 186.03 27.3093 185.134 27.72C184.257 28.1307 183.258 28.336 182.138 28.336ZM182.166 16.688C181.289 16.688 180.514 16.94 179.842 17.444C179.17 17.9293 178.741 18.676 178.554 19.684H185.47C185.414 18.7693 185.078 18.0413 184.462 17.5C183.846 16.9587 183.081 16.688 182.166 16.688ZM192.125 28V14.112H195.289L195.569 16.464C195.998 15.6427 196.614 14.9893 197.417 14.504C198.238 14.0187 199.199 13.776 200.301 13.776C202.018 13.776 203.353 14.3173 204.305 15.4C205.257 16.4827 205.733 18.0693 205.733 20.16V28H202.149V20.496C202.149 19.3013 201.906 18.3867 201.421 17.752C200.935 17.1173 200.179 16.8 199.153 16.8C198.145 16.8 197.314 17.1547 196.661 17.864C196.026 18.5733 195.709 19.5627 195.709 20.832V28H192.125ZM215.348 28C213.892 28 212.725 27.6453 211.848 26.936C210.971 26.2267 210.532 24.9667 210.532 23.156V17.108H208.152V14.112H210.532L210.952 10.388H214.116V14.112H217.868V17.108H214.116V23.184C214.116 23.856 214.256 24.3227 214.536 24.584C214.835 24.8267 215.339 24.948 216.048 24.948H217.784V28H215.348Z" fill="#00DC81"/>
</g>
<defs>
<clipPath id="clip0">
<rect width="219" height="40" fill="white"/>
</clipPath>
</defs>
</svg>

15
static/logo-light.svg
View File

@ -0,0 +1,15 @@
<svg width="219" height="40" viewBox="0 0 219 40" fill="none" xmlns="http://www.w3.org/2000/svg">
<g clip-path="url(#clip0)">
<path d="M14.6997 15.2543C15.553 16.7324 14.4864 18.58 12.7798 18.58H2.22023C0.513642 18.58 -0.552975 16.7323 0.300319 15.2543L5.58009 6.10858C6.43338 4.63047 8.56662 4.63047 9.41991 6.10858L14.6997 15.2543Z" fill="#00CD81"/>
<path d="M17.5801 27.5285C18.4334 26.0505 20.5666 26.0505 21.4199 27.5285L26.6997 36.6733C27.553 38.1512 26.4864 39.9987 24.7798 39.9987H14.2202C12.5136 39.9987 11.447 38.1512 12.3003 36.6733L17.5801 27.5285Z" fill="#003E27"/>
<path d="M21.4199 12.4702C20.5666 13.9482 18.4334 13.9482 17.5801 12.4702L12.3003 3.32539C11.447 1.84742 12.5136 0 14.2202 0H24.7798C26.4864 0 27.553 1.84742 26.6997 3.32539L21.4199 12.4702Z" fill="#99EBCD"/>
<path d="M12.7798 22C14.4864 22 15.553 23.8476 14.6997 25.3257L9.41991 34.4714C8.56662 35.9495 6.43338 35.9495 5.58009 34.4714L0.300319 25.3257C-0.552975 23.8476 0.513642 22 2.22023 22H12.7798Z" fill="#007B4D"/>
<path d="M39.82 28V14.112H42.984L43.264 16.464C43.6933 15.6427 44.3093 14.9893 45.112 14.504C45.9333 14.0187 46.8947 13.776 47.996 13.776C49.7133 13.776 51.048 14.3173 52 15.4C52.952 16.4827 53.428 18.0693 53.428 20.16V28H49.844V20.496C49.844 19.3013 49.6013 18.3867 49.116 17.752C48.6307 17.1173 47.8747 16.8 46.848 16.8C45.84 16.8 45.0093 17.1547 44.356 17.864C43.7213 18.5733 43.404 19.5627 43.404 20.832V28H39.82ZM70.2392 14.112V28H67.0752L66.7952 25.648C66.3658 26.4693 65.7405 27.1227 64.9192 27.608C64.1165 28.0933 63.1645 28.336 62.0632 28.336C60.3458 28.336 59.0112 27.7947 58.0592 26.712C57.1072 25.6293 56.6312 24.0427 56.6312 21.952V14.112H60.2152V21.616C60.2152 22.8107 60.4578 23.7253 60.9432 24.36C61.4285 24.9947 62.1845 25.312 63.2112 25.312C64.2192 25.312 65.0405 24.9573 65.6752 24.248C66.3285 23.5387 66.6552 22.5493 66.6552 21.28V14.112H70.2392ZM72.5743 28L77.6143 21.056L72.5743 14.112H76.4103L79.9383 19.04L83.4383 14.112H87.3023L82.2343 21.056L87.3023 28H83.4383L79.9383 23.072L76.4103 28H72.5743ZM95.7736 28C94.3176 28 93.151 27.6453 92.2736 26.936C91.3963 26.2267 90.9576 24.9667 90.9576 23.156V17.108H88.5776V14.112H90.9576L91.3776 10.388H94.5416V14.112H98.2936V17.108H94.5416V23.184C94.5416 23.856 94.6816 24.3227 94.9616 24.584C95.2603 24.8267 95.7643 24.948 96.4736 24.948H98.2096V28H95.7736ZM100.195 31.108L107.195 6.244H110.695L103.667 31.108H100.195Z" fill="#003E27"/>
<path d="M119.96 28.336C118.541 28.336 117.291 28.028 116.208 27.412C115.125 26.796 114.267 25.9373 113.632 24.836C113.016 23.7347 112.708 22.4747 112.708 21.056C112.708 19.6373 113.016 18.3773 113.632 17.276C114.267 16.1747 115.125 15.316 116.208 14.7C117.291 14.084 118.541 13.776 119.96 13.776C121.733 13.776 123.227 14.2427 124.44 15.176C125.653 16.0907 126.428 17.36 126.764 18.984H122.984C122.797 18.312 122.424 17.7893 121.864 17.416C121.323 17.024 120.679 16.828 119.932 16.828C118.943 16.828 118.103 17.2013 117.412 17.948C116.721 18.6947 116.376 19.7307 116.376 21.056C116.376 22.3813 116.721 23.4173 117.412 24.164C118.103 24.9107 118.943 25.284 119.932 25.284C120.679 25.284 121.323 25.0973 121.864 24.724C122.424 24.3507 122.797 23.8187 122.984 23.128H126.764C126.428 24.696 125.653 25.956 124.44 26.908C123.227 27.86 121.733 28.336 119.96 28.336ZM136.609 28.336C135.265 28.336 134.052 28.028 132.969 27.412C131.905 26.796 131.056 25.9467 130.421 24.864C129.805 23.7627 129.497 22.4933 129.497 21.056C129.497 19.6187 129.814 18.3587 130.449 17.276C131.084 16.1747 131.933 15.316 132.997 14.7C134.08 14.084 135.293 13.776 136.637 13.776C137.962 13.776 139.157 14.084 140.221 14.7C141.304 15.316 142.153 16.1747 142.769 17.276C143.404 18.3587 143.721 19.6187 143.721 21.056C143.721 22.4933 143.404 23.7627 142.769 24.864C142.153 25.9467 141.304 26.796 140.221 27.412C139.138 28.028 137.934 28.336 136.609 28.336ZM136.609 25.228C137.542 25.228 138.354 24.8827 139.045 24.192C139.736 23.4827 140.081 22.4373 140.081 21.056C140.081 19.6747 139.736 18.6387 139.045 17.948C138.354 17.2387 137.552 16.884 136.637 16.884C135.685 16.884 134.864 17.2387 134.173 17.948C133.501 18.6387 133.165 19.6747 133.165 21.056C133.165 22.4373 133.501 23.4827 134.173 24.192C134.864 24.8827 135.676 25.228 136.609 25.228ZM146.925 28V14.112H150.089L150.369 16.464C150.799 15.6427 151.415 14.9893 152.217 14.504C153.039 14.0187 154 13.776 155.101 13.776C156.819 13.776 158.153 14.3173 159.105 15.4C160.057 16.4827 160.533 18.0693 160.533 20.16V28H156.949V20.496C156.949 19.3013 156.707 18.3867 156.221 17.752C155.736 17.1173 154.98 16.8 153.953 16.8C152.945 16.8 152.115 17.1547 151.461 17.864C150.827 18.5733 150.509 19.5627 150.509 20.832V28H146.925ZM170.149 28C168.693 28 167.526 27.6453 166.649 26.936C165.771 26.2267 165.333 24.9667 165.333 23.156V17.108H162.953V14.112H165.333L165.753 10.388H168.917V14.112H172.669V17.108H168.917V23.184C168.917 23.856 169.057 24.3227 169.337 24.584C169.635 24.8267 170.139 24.948 170.849 24.948H172.585V28H170.149ZM182.138 28.336C180.738 28.336 179.497 28.0373 178.414 27.44C177.332 26.8427 176.482 26.0027 175.866 24.92C175.25 23.8373 174.942 22.5867 174.942 21.168C174.942 19.7307 175.241 18.452 175.838 17.332C176.454 16.212 177.294 15.344 178.358 14.728C179.441 14.0933 180.71 13.776 182.166 13.776C183.529 13.776 184.733 14.0747 185.778 14.672C186.824 15.2693 187.636 16.0907 188.214 17.136C188.812 18.1627 189.11 19.3107 189.11 20.58C189.11 20.7853 189.101 21 189.082 21.224C189.082 21.448 189.073 21.6813 189.054 21.924H178.498C178.573 23.0067 178.946 23.856 179.618 24.472C180.309 25.088 181.14 25.396 182.11 25.396C182.838 25.396 183.445 25.2373 183.93 24.92C184.434 24.584 184.808 24.1547 185.05 23.632H188.69C188.429 24.5093 187.99 25.312 187.374 26.04C186.777 26.7493 186.03 27.3093 185.134 27.72C184.257 28.1307 183.258 28.336 182.138 28.336ZM182.166 16.688C181.289 16.688 180.514 16.94 179.842 17.444C179.17 17.9293 178.741 18.676 178.554 19.684H185.47C185.414 18.7693 185.078 18.0413 184.462 17.5C183.846 16.9587 183.081 16.688 182.166 16.688ZM192.125 28V14.112H195.289L195.569 16.464C195.998 15.6427 196.614 14.9893 197.417 14.504C198.238 14.0187 199.199 13.776 200.301 13.776C202.018 13.776 203.353 14.3173 204.305 15.4C205.257 16.4827 205.733 18.0693 205.733 20.16V28H202.149V20.496C202.149 19.3013 201.906 18.3867 201.421 17.752C200.935 17.1173 200.179 16.8 199.153 16.8C198.145 16.8 197.314 17.1547 196.661 17.864C196.026 18.5733 195.709 19.5627 195.709 20.832V28H192.125ZM215.348 28C213.892 28 212.725 27.6453 211.848 26.936C210.971 26.2267 210.532 24.9667 210.532 23.156V17.108H208.152V14.112H210.532L210.952 10.388H214.116V14.112H217.868V17.108H214.116V23.184C214.116 23.856 214.256 24.3227 214.536 24.584C214.835 24.8267 215.339 24.948 216.048 24.948H217.784V28H215.348Z" fill="#00DC81"/>
</g>
<defs>
<clipPath id="clip0">
<rect width="219" height="40" fill="white"/>
</clipPath>
</defs>
</svg>

BIN
static/preview-dark.png
View File

Binary file not shown.
Side by Side

After

Width: 1280  |  Height: 640  |  Size: 28 KiB

BIN
static/preview.png
View File

Binary file not shown.
Side by Side

After

Width: 1280  |  Height: 640  |  Size: 29 KiB

Write Preview
Loading…
Cancel
Save