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

chore(docs): Improved CLI Examples #2303

Merged
merged 2 commits into from Nov 24, 2021
Merged

chore(docs): Improved CLI Examples #2303

merged 2 commits into from Nov 24, 2021

Conversation

alexandercerutti
Copy link
Contributor

Description

I tried to improve examples for what concerns CLI usages, which are not very clear.
I wanted also to compare Options from Advanced Usage with the one specified in the man file, but I wasn't able to understand quickly if all the options that can be set both through Node.JS API and CLI or if some are valid for CLI and others only for node.js (e.g. baseUrl). Let me know if I can improve also this aspect.

Let me know if I can change or if you don't like something. Thank you!

Contributor

  • Test(s) exist to ensure functionality and minimize regression (if no tests added, list tests covering this PR); or,
  • no tests required for this PR.
  • If submitting new feature, it has been documented in the appropriate places.

Committer

In most cases, this should be a different person than the contributor.

@vercel
Copy link

vercel bot commented Nov 24, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/markedjs/markedjs/BdeUCWWAN6SjrqpQ467G3JQGmLdb
✅ Preview: https://markedjs-git-fork-alexandercerutti-master-markedjs.vercel.app

@alexandercerutti alexandercerutti changed the title Improved CLI Examples Docs: Improved CLI Examples Nov 24, 2021
Copy link
Member

@UziTech UziTech left a comment

Choose a reason for hiding this comment

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

Thanks for helping improve marked! 💯

@UziTech UziTech added the category: docs Documentation changes label Nov 24, 2021
@UziTech UziTech changed the title Docs: Improved CLI Examples chore(docs): Improved CLI Examples Nov 24, 2021
@UziTech UziTech merged commit 6ac4d82 into markedjs:master Nov 24, 2021
@github-actions
Copy link

🎉 This PR is included in version 4.0.5 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: docs Documentation changes released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants