https://github.com/tyronejosee/project_fandomhub_docs

FandomHub (Docs): Documentation created for the API and platform of FandomHub, made with VitePress and Cloudflare Pages.
https://github.com/tyronejosee/project_fandomhub_docs

cloudflare clouflare-page docs markdown npm vitepress vue

Last synced: about 2 months ago
JSON representation

FandomHub (Docs): Documentation created for the API and platform of FandomHub, made with VitePress and Cloudflare Pages.

• Host: GitHub
• URL: https://github.com/tyronejosee/project_fandomhub_docs
• Owner: tyronejosee
• Created: 2024-06-11T23:30:09.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-29T00:12:32.000Z (over 1 year ago)
• Last Synced: 2025-01-11T02:42:32.583Z (about 1 year ago)
• Topics: cloudflare, clouflare-page, docs, markdown, npm, vitepress, vue
• Homepage: https://project-fandomhub-docs.pages.dev/
• Size: 749 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          


  

    

  

  

    

  





  
FandomHub - Docs

  Deploy on Cloudflare 🚀








Documentation created for the API and platform of FandomHub, made with VitePress and Cloudflare Pages.





  

    

  



## ⚙️ Installation

Clone the repository.

```bash

git clone git@github.com:tyronejosee/project_fandomhub_docs.git

```

Install dependencies.

```bash

npm i

```

Run the development server.

```bash

npm run docs:dev

```

Build the project for production.

```bash

npm run docs:build

```

## 💡 Github Pages (Optional)

```yml

name: FandomHub Github Pages

on:

  push:

    branches: [main]

  workflow_dispatch:

permissions:

  contents: read

  pages: write

  id-token: write

concurrency:

  group: pages

  cancel-in-progress: false

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout

        uses: actions/checkout@v4

        with:

          fetch-depth: 0

      - name: Setup Node

        uses: actions/setup-node@v4

        with:

          node-version: 20

          cache: npm

      - name: Setup Pages

        uses: actions/configure-pages@v4

      - name: Install dependencies

        run: npm ci

      - name: Build with VitePress

        run: |

          npm run docs:build # o pnpm docs:build / yarn docs:build / bun run docs:build

          touch docs/.vitepress/dist/.nojekyll

      - name: Upload artifact

        uses: actions/upload-pages-artifact@v3

        with:

          path: docs/.vitepress/dist

  deploy:

    environment:

      name: github-pages

      url: ${{ steps.deployment.outputs.page_url }}

    needs: build

    runs-on: ubuntu-latest

    name: Deploy

    steps:

      - name: Deploy to GitHub Pages

        id: deployment

        uses: actions/deploy-pages@v4

```