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 a FAQ to the readme #70

Closed
rexxars opened this issue Mar 28, 2017 · 3 comments
Closed

Add a FAQ to the readme #70

rexxars opened this issue Mar 28, 2017 · 3 comments
Labels
📚 area/docs This affects documentation 💪 phase/solved Post is done 🦋 type/enhancement This is great to have

Comments

@rexxars
Copy link
Collaborator

rexxars commented Mar 28, 2017

Things like how to do syntax highlighting and anchoring headers comes up a lot. Should probably add some links to solutions for those kind of problems to the readme.
@jikkujose
Copy link

Yes, same questions here! Any where to find the solution for them?

@QuicheSama
Copy link

@rexxars, advice on anchoring headers would be super rad. If you give me the details I can add it to the README and get a PR ready. Just let me know! 😃

@ChristianMurphy ChristianMurphy added 📚 area/docs This affects documentation 🦋 type/enhancement This is great to have and removed reference labels Oct 8, 2020
wooorm added a commit that referenced this issue Oct 16, 2020
@wooorm
Rewrite readme for unified, more examples
3d6702c 
* Lowercase filenames to scream less
* Add `remark-cli`, `remark-preset-wooorm` to format prose
* Use imports and fancy new JS features
* Add link to a markdown cheatsheet, as many questions are about that
* Add details tags showing equivalent JSX for examples, to clarify how markdown
  works
* Refactor options list, clean signatures
* Add examples on plugins, plugins w/ options, renderers (syntax highlighting),
  and combining plugins w/ renderers (math)
* Add sections on why to use this, security, contributing, related projects
* Add test for `react-katex` integration

Closes GH-70.
Closes GH-191.
Related to GH-474.
Closes GH-479.
Closes GH-480.
Related to GH-483.
@wooorm wooorm mentioned this issue Oct 16, 2020
Merged
wooorm added a commit that referenced this issue Oct 17, 2020
@wooorm
Rewrite readme for unified, more examples
1d81a44 
* Lowercase filenames to scream less
* Add `remark-cli`, `remark-preset-wooorm` to format prose
* Use imports and fancy new JS features
* Add link to a markdown cheatsheet, as many questions are about that
* Add details tags showing equivalent JSX for examples, to clarify how markdown
  works
* Refactor options list, clean signatures
* Add examples on plugins, plugins w/ options, renderers (syntax highlighting),
  and combining plugins w/ renderers (math)
* Add sections on why to use this, security, contributing, related projects
* Add test for `react-katex` integration

Closes GH-70.
Closes GH-191.
Related to GH-474.
Closes GH-479.
Closes GH-480.
Related to GH-483.
@wooorm wooorm closed this as completed in b3aa6e0 Oct 17, 2020
@wooorm
Copy link
Member

wooorm commented Oct 19, 2020

There are now many more examples in the readme

@wooorm wooorm added the 💪 phase/solved Post is done label Aug 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
📚 area/docs This affects documentation 💪 phase/solved Post is done 🦋 type/enhancement This is great to have
Milestone
No milestone
Development

No branches or pull requests
5 participants
@rexxars @jikkujose @wooorm @ChristianMurphy @QuicheSama