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

Example in READEME for how to use markdown.js in browser is wrong #263

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

xlwang-bupt
Copy link

  • If we follow the readme to use this markdown.js in browser, It will
    not be useful, return 'expose is undefined' and 'markdown is
    undefined',so i change some code in this html in READEME and
    lib/markdown.js.
  • It maybe not be wrong in old way which READEME described, it may be
    used in node environment,not run in just simply browser + html + js
  • I change some code ,so i could use it

- If we follow the readme to use this markdown.js in browser, It will
not be useful, return 'expose is undefined' and 'markdown is
undefined',so i change some code in this html in READEME and
lib/markdown.js.
- It maybe not be wrong in old way which READEME described, it may be
used in node environment,not run in just simply browser + html + js
- I change some code ,so i could use it
@ashb
Copy link
Collaborator

ashb commented Dec 10, 2015

The problem with the example is referring to an old way - but we now don't store a compiled version in the repo. You can get the a 'compiled' version of the source from the https://github.com/evilstreak/markdown-js/releases page.

The change as you have it would break non-browser use so can't be accepted, but an improvement to the docs to point at that and update the path in the example would be handy. Thanks!

@ashb ashb added the docs label Dec 10, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants