docs: update README (wip)
This commit is contained in:
@@ -1,6 +1,13 @@
|
|||||||
# md-blog
|
# md-blog
|
||||||
|
|
||||||
This template should help get you started developing with Vue 3 in Vite.
|
## Minimal setup
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone $REPOSITORY articles
|
||||||
|
cp .env.example .env
|
||||||
|
$EDITOR .env
|
||||||
|
bun run build
|
||||||
|
```
|
||||||
|
|
||||||
## TODO
|
## TODO
|
||||||
|
|
||||||
@@ -8,54 +15,11 @@ This template should help get you started developing with Vue 3 in Vite.
|
|||||||
- [x] render ~~mathjax~~ katex
|
- [x] render ~~mathjax~~ katex
|
||||||
- [x] render ~~plantuml~~ mermaid
|
- [x] render ~~plantuml~~ mermaid
|
||||||
- [x] custom css in sub repo
|
- [x] custom css in sub repo
|
||||||
- [ ] custom layout in sub repo ?
|
|
||||||
- [x] build RSS feed
|
- [x] build RSS feed
|
||||||
- [x] link to home
|
- [x] link to home
|
||||||
- [ ] link to previous/next article
|
|
||||||
- [x] set page title
|
- [x] set page title
|
||||||
- [x] SPA and opengraph
|
- [x] SPA and opengraph
|
||||||
|
- [ ] build with github actions
|
||||||
## Recommended IDE Setup
|
- [ ] proper docs
|
||||||
|
- [ ] custom layout in sub repo ?
|
||||||
[VS Code](https://code.visualstudio.com/) + [Vue (Official)](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur).
|
- [ ] link to previous/next article
|
||||||
|
|
||||||
## Recommended Browser Setup
|
|
||||||
|
|
||||||
- Chromium-based browsers (Chrome, Edge, Brave, etc.):
|
|
||||||
- [Vue.js devtools](https://chromewebstore.google.com/detail/vuejs-devtools/nhdogjmejiglipccpnnnanhbledajbpd)
|
|
||||||
- [Turn on Custom Object Formatter in Chrome DevTools](http://bit.ly/object-formatters)
|
|
||||||
- Firefox:
|
|
||||||
- [Vue.js devtools](https://addons.mozilla.org/en-US/firefox/addon/vue-js-devtools/)
|
|
||||||
- [Turn on Custom Object Formatter in Firefox DevTools](https://fxdx.dev/firefox-devtools-custom-object-formatters/)
|
|
||||||
|
|
||||||
## Type Support for `.vue` Imports in TS
|
|
||||||
|
|
||||||
TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types.
|
|
||||||
|
|
||||||
## Customize configuration
|
|
||||||
|
|
||||||
See [Vite Configuration Reference](https://vite.dev/config/).
|
|
||||||
|
|
||||||
## Project Setup
|
|
||||||
|
|
||||||
```sh
|
|
||||||
bun install
|
|
||||||
```
|
|
||||||
|
|
||||||
### Compile and Hot-Reload for Development
|
|
||||||
|
|
||||||
```sh
|
|
||||||
bun dev
|
|
||||||
```
|
|
||||||
|
|
||||||
### Type-Check, Compile and Minify for Production
|
|
||||||
|
|
||||||
```sh
|
|
||||||
bun run build
|
|
||||||
```
|
|
||||||
|
|
||||||
### Lint with [ESLint](https://eslint.org/)
|
|
||||||
|
|
||||||
```sh
|
|
||||||
bun lint
|
|
||||||
```
|
|
||||||
Reference in New Issue
Block a user