Skip to content

Commit dfb9471

Browse files
committed
Add MarkBind as dependency
1 parent 1a563d1 commit dfb9471

File tree

4 files changed

+4529
-0
lines changed

4 files changed

+4529
-0
lines changed

.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ bin/**
3232
.DS_Store
3333
docs/_site/
3434
docs/_markbind/logs/
35+
_markbind/logs/
3536

3637
# IntelliJ test coverage report files
3738
/htmlReport/
39+
40+
# Dependencies directories
41+
/node_modules/

docs/SettingUp.md

+17
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,23 @@ If you plan to use Intellij IDEA (highly recommended):
3131
1. Run the `seedu.address.Main` and try a few commands.
3232
1. [Run the tests](Testing.md) to ensure they all pass.
3333

34+
---
35+
36+
## Setting up a local documentation website
37+
38+
This will generate a website from the MarkBind source files in the `docs` directory, start a web server, and open a live preview of your site in your default browser.
39+
40+
1. Ensure that you have [Node.js](https://nodejs.org/en) installed, otherwise install it from [here](https://nodejs.org/en).
41+
2. Run `npm install` to install dependencies.
42+
3. Run `npm run serve` to serve the MarkBind documentation site locally.
43+
4. Visit the site on your browser at `http://127.0.0.1:8080/`.
44+
45+
<box type="tip" seamless>
46+
47+
**Tip:**
48+
By setting up this documentation website, you can immediately view your documentation modifications locally and fix any formatting issues that appear.
49+
</box>
50+
3451
--------------------------------------------------------------------------------------------------------------------
3552

3653
## Before writing code

0 commit comments

Comments
 (0)