Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve User Guide - Getting Started and .gitignore file #1924

Merged
merged 1 commit into from
May 8, 2022

Conversation

tlylt
Copy link
Contributor

@tlylt tlylt commented May 5, 2022

What is the purpose of this pull request?

  • Documentation update
  • Bug fix
  • Feature addition or enhancement
  • Code maintenance
  • Others, please explain:

Overview of changes:
Fixes #1772

  • Include a quick start section using npx
  • Include a guide on how to install MarkBind as a dev dependency
  • Include a page about .gitignore files (Related to Generate sensible .gitignore when running markbind init #1782, I think having a reference is useful, regardless of whether we ended up providing a default one)

Anything you'd like to highlight / discuss:
nil

Testing instructions:
https://deploy-preview-1924--markbind-master.netlify.app/userguide/gettingstarted
https://deploy-preview-1924--markbind-master.netlify.app/userguide/gitignorefile

Proposed commit message: (wrap lines at 72 characters)
Improve User Guide - Getting Started and .gitignore file


Checklist: ☑️

  • Updated the documentation for feature additions and enhancements
  • Added tests for bug fixes or features
  • Linked all related issues
  • No unrelated changes

@tlylt tlylt requested a review from ong6 May 5, 2022 05:00
Copy link
Contributor

@jonahtanjz jonahtanjz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work @tlylt.

LGTM 👍

@jonahtanjz jonahtanjz added this to the 4.0 milestone May 6, 2022
@jonahtanjz jonahtanjz merged commit 8d57059 into MarkBind:master May 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add examples of using npx to setup MarkBind sites in the user guide
2 participants