Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion .eslintignore
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ packages/core/src/lib/markdown-it/plugins/*

# --- packages/core end ---

# --- packages/cli ---
packages/cli/dist/**/*.js
# --- packages/cli end ---

!.eslintrc.js

# --- packages/vue-components ---
Expand All @@ -48,4 +52,4 @@ packages/vue-components/src/utils/utils.js

# --- packages/vue-components end ---

dangerfile.js
dangerfile.js
8 changes: 7 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,12 @@ packages/core/index.js
packages/core/src/lib/progress/*.js
# --- packages/core end ---

# Manual type definitions need to be included
!packages/cli/src/lib/live-server/index.d.ts

# Nx for Lerna
.nx/cache
.nx/workspace-data
.nx/workspace-data

# Build folder
dist/
13 changes: 10 additions & 3 deletions docs/devGuide/development/settingUp.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,19 @@ We recommend the **WebStorm IDE** or **VS Code** for working with MarkBind code.

1. **Fork and clone** the MarkBind repo.

1. **Bind your cloned version of MarkBind to your console** by navigating to the cloned `packages/cli` folder and running `npm link`

1. **Install dependencies** by running
<popover content="Under the hood, this calls `npm ci` and `npm prepare`">`npm run setup`</popover>
<popover content="Under the hood, this calls `npm ci` and `npm run build:backend`">`npm run setup`</popover>
in the **root folder** of your cloned repo.

1. **Bind your cloned version of MarkBind to your console** by navigating to the cloned `packages/cli` folder and running `npm link`

<box type="warning" class="ms-4" seamless>

If the `markbind` command fails to execute with permission issues in the console, add execute permissions to the generated file in `packages/cli/dist/index.js`

To prevent this from occurring, it is recommended to use the `dev`/`build:backend` scripts as described in [the workflow](workflow.md#editing-backend-features)
</box>

1. **Congratulations!** Now you are ready to start modifying MarkBind code.


Expand Down
1 change: 1 addition & 0 deletions docs/devGuide/development/workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ The sections below has more information about various stages of submitting a PR.
**1. Using the docs as a development environment**, with:
* the <a tags="environment--combined" href="/userGuide/cliCommands.html#serve-command">lazy reload`-o`</a><a tags="environment--dg" href="https://markbind.org/userGuide/cliCommands.html#serve-command">lazy reload`-o`</a> option to speed up page building
* the `-d` developer option. (see [below](#editing-frontend-features))
* the project-bundled `tsx` as a [TypeScript runner](https://nodejs.org/en/learn/typescript/run)

{.mb-3}

Expand Down
Binary file modified docs/images/debugger/WebStorm_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading