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

Feature: add escape for markdown parsing #68

Closed
3 tasks done
kellymears opened this issue May 22, 2021 · 2 comments
Closed
3 tasks done

Feature: add escape for markdown parsing #68

kellymears opened this issue May 22, 2021 · 2 comments
Labels
good first issue Good for newcomers

Comments

@kellymears
Copy link
Member

Summary

Super low priority.

It is not currently possible to escape markdown parsing for docs pages.

The only issue this causes right now is trying to describe the markdown parsing in the dev docs.

Motivation

It would be nice to be able to escape markdown parsing.

Maybe something like:

{no-parse}
[Some doc page](docs:config/doc-page)
{end-no-parse}

But, I haven't given it much thought.

Additional context

Current rules:

  • Docs links:
[Some doc page](docs:config/doc-page) => 
[Some doc page](https://github.com/roots/bud/tree/stable/docs/config/doc-page)
  • Pkg links:
[Some repo path](url:packages/@roots/bud/src) => 
[Some repo path](https://github.com/roots/bud/tree/stable/packages/@roots/bud/src)
  • surrounding a repo pkg name with backticks becomes a link to the package root
`@roots/bud` => [@roots/bud](https://github.com/roots/bud/tree/stable/packages/@roots/bud)
  • [badge](npm:@roots/bud) becomes a badge
  • @user/repo becomes a link to whatever github repo

All of this is in https://github.com/roots/bud/tree/stable/dev/docs/gen/remark.ts. Some of it is powered by remark; the more specific stuff is just regex parsing.

@kellymears kellymears added the good first issue Good for newcomers label May 22, 2021
@kellymears
Copy link
Member Author

@kellymears
Copy link
Member Author

This issue is closed by #148 now that we've moved on to using docusaurus.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant