Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Changes to this repository are built daily at 0:00 UTC and uploaded to https://vhdplus.com

Node.js CI

Requirements

  • Node.js version >= 8.9 or above (which can be checked by running node -v). You can use nvm for managing multiple Node versions on a single machine installed

Initialize docusaurus

  1. Install requirements

  2. Clone repository

git clone https://github.com/VHDPlus/vhdplus-website.git
  1. Navigate to cloned directory and install node modules:
cd vhdplus-website
npm install
  1. Execute npm start to start live preview!

Editing Content

Editing an existing docs page

Edit docs by navigating to docs/ and editing the corresponding document:

docs/doc-to-be-edited.md

---
id: page-needs-edit
title: This Doc Needs To Be Edited
---

Edit me...

For more information about docs, click here

Editing an existing blog post

Edit blog posts by navigating to website/blog and editing the corresponding post:

website/blog/post-to-be-edited.md

---
id: post-needs-edit
title: This Blog Post Needs To Be Edited
---

Edit me...

For more information about blog posts, click here

Adding Content

Adding a new docs page to an existing sidebar

  1. Create the doc as a new markdown file in /docs, example docs/newly-created-doc.md:
---
id: newly-created-doc
title: This Doc Needs To Be Edited
---

My new content here..
  1. Refer to that doc's ID in an existing sidebar in website/sidebar.json:
// Add newly-created-doc to the Getting Started category of docs
{
  "docs": {
    "Getting Started": [
      "quick-start",
      "newly-created-doc" // new doc here
    ],
    ...
  },
  ...
}

Full documentation can be found on the website.

About

Official VHDPlus Website

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published