Skip to content

aborn/mindpress

Repository files navigation

MindPress

cd

Press your mind(markdown) gracefully, which is powered by nuxt.js 3.0 and nuxt content 2.0. Markdown editor use md-editor-v3. Mindpress provides two site mode: server (SSR) and static (default, SSG). For server mode, you can edit/save markdown file upstream from another api server. Here is an java language server api implementation mindpress-serv. For static mode, mindpress use nuxt static site generation (SSG) prerenders every route of your markdown files at build time. Here is static site example https://aborn.github.io/mindpress/, which is hosted by github pages.

Server mode

  1. The home page /

index

  1. Edit file /edit/articleid

edit

  1. Markdown file(article) detail /article/articleid

article

  1. Create new file /edit

new

  1. Search by keyword /search

search

  1. Tag group page /tag/your_query_tag

tag

  1. My space docs /my

my

Setup

Make sure to install the dependencies:

# yarn
yarn install

# npm
npm install

# pnpm
pnpm install --shamefully-hoist

Development Server

Start the development server on http://localhost:6001

yarn dev

Production

Build the application for production:

npm run build

Locally preview production build:

npm run preview

Checkout the deployment documentation for more information.

About

Press your mind(markdown) gracefully, which is powered by nuxt.js 3.0 and nuxt.js content 2.0.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published