Easy to install
Run
pnpm create vuepress-theme-hope hope-projectto create a new project with this theme.Run
pnpm create vuepress-theme-hope add .in your project root to create a new project with this theme.
Add things you want in markdown
We extended the standard commonMark specification and added tons of new features for you.
Links Check
Check markdown links
Hint box
Decorate Markdown content with styles
GFM alerts
GFM alert box
Tabs
Group similar content with tabs and switch them together
Code Tabs
Group similar codes with tabs
Custom Align
Let you decide to align paragraphs in the way you like
Attrs
Allow you to add attributes for Markdown content
Superscript and subscript
Inserting superscript and subscript
Footnote
Your Markdown now support footnotes
Mark
Mark and highlight contents
Spoiler
Mark spoiler contents
Tasklist
Use tasklist in Markdown
Image syntax
improve syntax to specify size and color scheme
Component Support
Easily insert components in Markdown
Components
Common components out fo box
Chart Support
Display charts in Markdown
Flowchart Support
Create your flowchart in Markdown
Mermaid Support
Add mermaid diagram in Markdown
Plantuml Support
Add plantuml in Markdown
Tex Support
Markdown now have Tex Support so you can write your formula
Include snippet Support
split your docs with different parts and import them in Markdown
Playground Support
You can add playground in Markdown files
Kotlin playground Support
Reactive kotlin playground
Vue playground Support
Show living vue component in playground
Sandpack playground Support
A live coding environment driven by Sandpack.
Code Demo Support
You can insert code demo easily
Presentation Support
Insert presentation in Markdown files via Reveal.js
Customizable UI
Customizable outlook with full a11y support.
Improved layouts
An awesome responsive layout
New features
Catalog Page
Auto generating catalog page and out of box catalog component
Pageviews and Comments
Pageview statistics and comment support with 4 comment service
Article Information
Add author, writing date, reading time, word count and other information to your article
Article Encryption
Encrypt you articles based on page links, so that only the one you want could see them
Search
Support docsearch and client search
Code Block
Customize code block themes, line number, highlight lines, copy button, etc.
Image Preview
Support viewing, zooming, sharing your page images like a gallery
Advanced
Advanced features to improve site SEO and user experience
This is an example of a project homepage. You can place your main content here.
To use this layout, you need to set home: true in the page front matter.
For related descriptions of configuration items, please see Project HomePage Layout Config.