https://github.com/fu-sen/vercel-mkdocs

📃 MkDocs with ▲ Vercel (minimal configuration)
https://github.com/fu-sen/vercel-mkdocs

mkdocs vercel

Last synced: about 1 month ago
JSON representation

📃 MkDocs with ▲ Vercel (minimal configuration)

• Host: GitHub
• URL: https://github.com/fu-sen/vercel-mkdocs
• Owner: fu-sen
• Created: 2021-03-20T08:01:07.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-09-14T01:43:34.000Z (over 2 years ago)
• Last Synced: 2023-08-03T20:09:59.591Z (over 1 year ago)
• Topics: mkdocs, vercel
• Homepage: https://mkdocs-s.vercel.app
• Size: 10.7 KB
• Stars: 11
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Vercel-MkDocs

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Ffu-sen%2FVercel-MkDocs)

**MkDocs with ▲Vercel (minimal configuration)**

- [▲ Vercel](https://vercel.com/)

- [MkDocs](https://www.mkdocs.org/)

## How to use

1. Edit `mkdocs.yml` and `docs/index.md`, add more files if needed.

2. Add the pip package to `requirements.txt` . (Themes and plugins)

3. Use the Vercel command: `vercel dev` `vercel` and `vercel --prod`  

or commit to a Git project: `git push`

You do not need to change the `Build & Development Settings` item.

## Build error

Many of the build error are that you mistyped `mkdocs.yml`

or you forgot to add the package to` requirements.txt`.

Check the file change immediately before the error occurred.

This is often not a problem with this project.

You should not open an issue for that.

## Fork of this project

If you fork this project, be sure to change something and commit.

If you re-deploy without changing anything, it's my commit and I'll be notified.

You can also create a new project without forking or use the [Vercel CLI](https://vercel.com/docs/cli) without creating a project.