feat(docs): add docs via docus and CI/CD pipeline for deployment to s…

…idebase.io (#39)

* Added demo docs and sync workflow

* Renamed secret

* Fixed Typo!

* Update 0.index.md

* Updated docs

* Updated workflow trigger

* Updated placeholder docs

* Delete .env.example

.github/sync.yml

@@ -0,0 +1,8 @@
+sidebase/nuxt-session:
+  - docs/content
+  - docs/public
+sidebase/docs:
+  - source: docs/content/
+    dest: content/3.nuxt-session/
+  - source: docs/public/
+    dest: public/

.github/workflows/sync.yaml

@@ -0,0 +1,16 @@
+name: Sync docs
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@master
+      - name: Run GitHub File Sync
+        uses: BetaHuhn/repo-file-sync-action@v1
+        with:
+          GH_PAT: ${{ secrets.GH_TOKEN }}

docs/.gitignore

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

docs/.npmrc

@@ -0,0 +1,2 @@
+shamefully-hoist=true
+strict-peer-dependencies=false

docs/README.md

@@ -0,0 +1,57 @@
+# Docus Starter
+
+Starter template for [Docus](https://docus.dev).
+
+## Clone
+
+Clone the repository (using `nuxi`):
+
+```bash
+npx nuxi init docs -t nuxt-themes/docus-starter
+```
+
+## Setup
+
+Install dependencies:
+
+```bash
+yarn install
+```
+
+## Development
+
+```bash
+yarn dev
+```
+
+## Edge Side Rendering
+
+Can be deployed to Vercel Functions, Netlify Functions, AWS, and most Node-compatible environments.
+
+Look at all the available presets [here](https://v3.nuxtjs.org/guide/deploy/presets).
+
+```bash
+yarn build
+```
+
+## Static Generation
+
+Use the `generate` command to build your application.
+
+The HTML files will be generated in the .output/public directory and ready to be deployed to any static compatible hosting.
+
+```bash
+yarn generate
+```
+
+## Preview build
+
+You might want to preview the result of your build locally, to do so, run the following command:
+
+```bash
+yarn preview
+```
+
+---
+
+For a detailed explanation of how things work, check out [Docus](https://docus.dev).

docs/app.config.ts

@@ -0,0 +1,5 @@
+export default defineAppConfig({
+  docus: {
+    title: 'My Docs'
+  }
+})

docs/content/1.index.md

@@ -0,0 +1,8 @@
+---
+title: nuxt-session docs
+aside: false
+---
+
+# Oh no! You are a bit early
+
+These docs will be migrated soon, you can find the current documentation [here](https://github.com/sidebase/nuxt-session).

docs/content/_dir.yml

@@ -0,0 +1,2 @@
+title: nuxt-session
+icon: heroicons-outline:clock

docs/nuxt.config.ts

@@ -0,0 +1,3 @@
+export default defineNuxtConfig({
+  extends: '@nuxt-themes/docus'
+})