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 support
Allow you to add attributes for Markdown content
Superscript and subscript support
Your Markdown now support superscript and subscript
Footnote support
Your Markdown now support footnotes
Mark Support
Mark words and sentences in Markdown
Tasklist Support
Use tasklist in Markdown
image syntax
improve syntax to specify size and color scheme
Component Support
Easily insert components in Markdown
Chart Support
Display charts in Markdown
Flowchart Support
Create your flowchart in Markdown
Mermaid Support
Add mermaid diagram 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
Vue playground Support
Show living vue component in playground
Code Demo Support
You can insert code demo easily
Presentation Support
Insert presentation in Markdown files via Reveal.js
Improved layouts
An awesome responsive layout with full a11y support.
Layout
Improved navbar, sidebar, page nav and new breadcrumb, footer and toc. We also bring you a brand new homepage.
Dark Mode
Switch between light and dark modes freely
Customizable Theme Color
Customize theme color
Slide Page
Adding slide pages to display things you like
More
RTL layout, print support, fullscreen button, etc.
New features
Pageviews and Comments
Start pageview statistics and comment support with Waline
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
Copy Code Blocks
Copy codes with one click in code blocks
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.