Skip to content

Commit

Permalink
feat: new docs framework
Browse files Browse the repository at this point in the history
  • Loading branch information
ayushsharma82 committed Nov 22, 2024
1 parent 452f043 commit 5137606
Show file tree
Hide file tree
Showing 283 changed files with 9,133 additions and 26,511 deletions.
3 changes: 3 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": "next/core-web-vitals"
}
111 changes: 82 additions & 29 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -1,40 +1,93 @@
name: Docusaurus Build & Deploy
# Sample workflow for building and deploying a Next.js site to GitHub Pages
#
# To get started with Next.js see: https://nextjs.org/docs/getting-started
#
name: Deploy to GH Pages

on:
# Runs on pushes targeting the default branch
push:
branches:
- docs
# Review gh actions docs if you want to further define triggers, paths, etc
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
branches: ["docs"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
deploy:
name: Deploy to GitHub Pages
# Build job
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
- name: Checkout
uses: actions/checkout@v4
- name: Detect package manager
id: detect-package-manager
run: |
if [ -f "${{ github.workspace }}/yarn.lock" ]; then
echo "manager=yarn" >> $GITHUB_OUTPUT
echo "command=install" >> $GITHUB_OUTPUT
echo "runner=yarn" >> $GITHUB_OUTPUT
exit 0
elif [ -f "${{ github.workspace }}/package.json" ]; then
echo "manager=npm" >> $GITHUB_OUTPUT
echo "command=ci" >> $GITHUB_OUTPUT
echo "runner=npx --no-install" >> $GITHUB_OUTPUT
exit 0
else
echo "Unable to determine package manager"
exit 1
fi
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: 18
cache: npm

node-version: "20"
cache: ${{ steps.detect-package-manager.outputs.manager }}
- name: Setup Pages
uses: actions/configure-pages@v5
with:
# Automatically inject basePath in your Next.js configuration file and disable
# server side image optimization (https://nextjs.org/docs/api-reference/next/image#unoptimized).
#
# You may remove this line if you want to manage the configuration yourself.
static_site_generator: next
- name: Restore cache
uses: actions/cache@v4
with:
path: |
.next/cache
# Generate a new cache whenever packages or source files change.
key: ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}-${{ hashFiles('**.[jt]s', '**.[jt]sx') }}
# If source files changed but packages didn't, rebuild from a prior cache.
restore-keys: |
${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}-
- name: Install dependencies
run: yarn install --frozen-lockfile
- name: Build website
run: yarn build
run: ${{ steps.detect-package-manager.outputs.manager }} ${{ steps.detect-package-manager.outputs.command }}
- name: Build with Next.js
run: ${{ steps.detect-package-manager.outputs.runner }} next build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./out

# Popular action to deploy to GitHub Pages:
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Build output to publish to the `gh-pages` branch:
publish_dir: ./build
# The following lines assign commit authorship to the official
# GH-Actions bot for deploys to `gh-pages` branch:
# https://github.com/actions/checkout/issues/13#issuecomment-724415212
# The GH actions bot is used by default if you didn't specify the two fields.
# You can swap them out with your own user credentials.
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com
id: deployment
uses: actions/deploy-pages@v4
24 changes: 0 additions & 24 deletions .github/workflows/test-deploy.yml

This file was deleted.

46 changes: 35 additions & 11 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,20 +1,44 @@
# Dependencies
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.*
.yarn/*
!.yarn/patches
!.yarn/plugins
!.yarn/releases
!.yarn/versions

# Production
/build
# testing
/coverage

# Generated files
.docusaurus
.cache-loader
# next.js
/.next/
/out/

# production
/build

# Misc
# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# env files (can opt-in for commiting if needed)
.env*

# vercel
.vercel

# typescript
*.tsbuildinfo
next-env.d.ts

# dev
/portal
/out
48 changes: 13 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,19 @@
# Website
# ESP-DASH Docs

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

### Installation
Run the following commands to start the development server:

```
$ yarn
```

### Local Development

```
$ 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.

### Build

```
$ yarn build
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```

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

### Deployment

Using SSH:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

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.
You can start editing the page by modifying `pages/index.mdx`. The page auto-updates as you edit the file.
3 changes: 0 additions & 3 deletions babel.config.js

This file was deleted.

5 changes: 0 additions & 5 deletions blog/authors.yml

This file was deleted.

7 changes: 7 additions & 0 deletions components/Badge.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export default function Badge() {
return (
<span className="_flex _items-center">
<img src="/img/pro-badge.gif" width={32} />
</span>
)
}
18 changes: 18 additions & 0 deletions components/ProCallout.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { Callout } from 'nextra/components'

export default function ProCallout() {
return (
<a href="https://espdash.pro" target="_blank">
<Callout type="info" emoji={<img src="/img/pro-badge.gif" className='block' alt="" width={48} />}>
<div className='flex flex-row items-center gap-2'>
<span>
This feature is only available in ESP-DASH Pro
</span>
<span className='block mb-1'>
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round" class="lucide lucide-external-link"><path d="M15 3h6v6"/><path d="M10 14 21 3"/><path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"/></svg>
</span>
</div>
</Callout>
</a>
)
}
25 changes: 0 additions & 25 deletions docs/commercial-license.md

This file was deleted.

52 changes: 0 additions & 52 deletions docs/concept.md

This file was deleted.

4 changes: 0 additions & 4 deletions docs/features/_category_.json

This file was deleted.

Loading

0 comments on commit 5137606

Please sign in to comment.