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.

Sign up for GitHub

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

Jump to bottom

Add Getting Started Document and Readme Section #95

Closed
3 tasks done
wooorm opened this issue Nov 23, 2015 · 0 comments
Closed
3 tasks done

Add Getting Started Document and Readme Section #95

wooorm opened this issue Nov 23, 2015 · 0 comments
Labels
remark remark-cli 🦋 type/enhancement This is great to have

Comments

@wooorm
Copy link
Member

wooorm commented Nov 23, 2015

Although there’s a lot of documentation, findability is an issue (1, 2).

I propose to:

  • Rename doc/getting-started.md to doc/installation.md;
  • Add doc/getting-started.md with a short guide on how to start processing with mdast(3) and mdast(1), and an introduction to the different docs;
  • Add Getting Started section to readme.md, linking to doc/getting-started.md;

Supersedes remarkjs/remark-lint#29.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
remark remark-cli 🦋 type/enhancement This is great to have
Milestone
No milestone
Development

No branches or pull requests
1 participant
@wooorm