Update docs #1081

joshbruce · 2018-02-25T19:26:13Z

Description

This PR helps break up the README into more consumable chunks.

Submitter

Test(s) exist to ensure functionality works (if no new tests added, list which tests cover this functionality); or,
no tests required for this PR.

Reviewer

Draft GitHub release notes have been updated.
case_insensitive_refs is only failing test (remove once CI is in place and all tests pass).
All lint checks pass (remove once CI is in place).
Merge PR

Feder1co5oave · 2018-02-25T20:23:05Z

Josh, this is the third PR you've opened concerning updates to the README. Can you slow down a bit? I cannot follow you around in all these new issues.

Remember if you change your mind on some commits you make in the PR branch you can always rewrite them by git reset or git rebase and then git push --force, and the commits will be re-written. This is generally NOT safe to do on a shared public branch because it can "break" the branching history on the collaborators' local copies, but since this is a WIP and you're the only one pushing, it can be considered safe to do, before merging.

joshbruce · 2018-02-25T21:06:12Z

That's fair. Not sure the other specific PRs you're referring to - I only have two opened at the moment: #1076 (0.3.17 release updating PR templates) and this one.

I believe the others might have been merged or closed...I did run into an issue where GitHub was listing my PRs as being from an "unknown repository," which I've never seen before now; therefore, some of the closings were due to that. Don't think I'll be opening any more new things for a bit. :)

Definitely understand the feeling though - this is what it felt like when @chjj and I were doing the organization thing - things were done before I could hit reply. ;)

joshbruce · 2018-02-25T21:38:57Z

USAGE_EXTENSIBILITY.md

@@ -0,0 +1,136 @@
+## Extending Marked


@Feder1co5oave, @UziTech, and @styfle: Could use some help on the content here, I think. Purpose is to document and demonstrate overriding/extending the renderer, lexer, and parser...seems we are light on documentation there.

joshbruce · 2018-02-25T21:39:55Z

USAGE_EXTENSIBILITY.md

+	<li><a href="#parser">The parser</a></li>
+</ul>
+
+<h2 id="rederer">The renderer</h2>


The renderer...

Why are you using HTML here? Instead of <h2> you can use ## Renderer

Fair question. For the id attribute. Is there another way to get inline anchors to work properly using GitHub Markdown??

Consolidating comments from #1061: I've always run into issues there [GitHub automatically generating IDs]; so, normally end up doing it by hand. Also, could make it more difficult to use in a non-GFM setting; at least here we know the TOC will always work[...like pulling in the Markdown file into a separate context outside of the GFM markdown rendering.]

I typically let github generate it like so: https://github.com/styfle/copee#demo
But a TOC is a good point, you don't want to accidentally break it if you change the heading later.

joshbruce · 2018-02-25T21:40:04Z

USAGE_EXTENSIBILITY.md

+- image(*string* href, *string* title, *string* text)
+- text(*string* text)
+
+<h2 id="lexer">The lexer</h2>


The lexer...

joshbruce · 2018-02-25T21:40:13Z

USAGE_EXTENSIBILITY.md

+The lexer is...
+
+
+<h2 id="parser">The parser</h2>


The parser...

joshbruce · 2018-02-25T21:40:29Z

USAGE_EXTENSIBILITY.md

+
+The parser is...
+
+***


The current documentation for the lexer and parser

joshbruce · 2018-02-25T23:15:15Z

Extensibility could use some more detail; doesn't necessarily need to be in this PR.
Think this should be merged before Release 0.3.17 (template updates) - ?? #1076 to test the process on being able to update the release PR as long as the publish has not been run.
This should give us a much tighter README (presence on NPM) and the foundation for a possible GitHub Pages site down the road (thanks for the recommendation and good looking out @styfle).

JS seems off for USAGE_ADVANCED asyn highlighting

styfle · 2018-02-27T00:44:49Z

AUTHORS.md

- Tony Brix @UziTech
- Federico Soave @Feder1co5oave
+- Tony Brix @UziTech - really good at the test harness and environment setup
+- Federico Soave @Feder1co5oave - really good at the regex things
 - Steven @styfle


Steven @styfle - good for nothing

😜

I honestly thought about putting: Good for lying in the weeds and randomly showing with a nugget of excess truth on operations before disappearing again. 😝

Update docs

Josh Bruce added 3 commits February 18, 2018 22:19

Update read me with TOC & other changes

1bcc02f

typos

170ab8c

Initial product vision

5c6aeb3

joshbruce self-assigned this Feb 25, 2018

Josh Bruce added 4 commits February 25, 2018 15:17

Add advanced usage

9dacd66

Table alignments

4a7d3d4

Table alignments

59dfb46

Table alignment

9ccb038

Josh Bruce added 2 commits February 25, 2018 15:32

Highlight consolidated

eef65ef

Base README

3c476fc

Josh Bruce added 2 commits February 25, 2018 16:20

Add AUTHORS page

606e896

Renderer, lexer, parser

f1dfed3

joshbruce commented Feb 25, 2018

View reviewed changes

USAGE_EXTENSIBILITY.md

The lexer is...

<h2 id="parser">The parser</h2>

Copy link

Member Author

joshbruce Feb 25, 2018

Choose a reason for hiding this comment

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

The parser...

joshbruce commented Feb 25, 2018

View reviewed changes

USAGE_EXTENSIBILITY.md

The parser is...

***

Copy link

Member Author

joshbruce Feb 25, 2018 •

edited

Loading

Choose a reason for hiding this comment

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

The current documentation for the lexer and parser

Josh Bruce added 2 commits February 25, 2018 17:29

Update contributing and license

f5b8f7b

Merge branch 'master' into update-readme

9fc0444

joshbruce changed the base branch from update-readme to master February 25, 2018 22:46

Josh Bruce added 6 commits February 25, 2018 17:58

Beginning RELEASE refinement

b378f32

Update RELEASE

45d3258

Link to authors in TOC

50edf00

Minor rephrase

424aaa7

Move TOC to top

dd162d8

Used Marked as header test

8e9bf0d

Josh Bruce added 4 commits February 25, 2018 21:56

Typos and grammar

9546f7f

Typos

64bcb72

Typo

11f1645

JS seems off for USAGE_ADVANCED asyn highlighting

Replace tabs with spaces

9f1342f

joshbruce added the RR - refactor & re-engineer Results in an improvement to developers using Marked, or end-users, or both. label Feb 26, 2018

Josh Bruce added 2 commits February 26, 2018 14:49

Add different membership types to the community

17dcbaf

Update authors and security-related readme

eeb8c08

joshbruce mentioned this pull request Feb 26, 2018

security: fix REDOS vulnerabilities #1083

Merged

Josh Bruce added 6 commits February 26, 2018 16:34

What we're good at

871ca4c

typo

5ed35de

Expound on publishers responsibilities

3f7f7f8

Make sure running tests is part of contributing

6754302

Don't need run

d995d64

Add test:lint and update lint

766d6c9

This was referenced Feb 27, 2018

Coding standards #1089

Closed

Setup .editorconfig #1082

Merged

styfle reviewed Feb 27, 2018

View reviewed changes

Josh Bruce added 2 commits February 26, 2018 20:54

Update users definition

4478d36

grammar

14398fc

joshbruce mentioned this pull request Feb 27, 2018

Run lint tests with regular test suite #1088

Merged

7 tasks

Josh Bruce added 4 commits February 26, 2018 22:03

Add npm install to setting up local checklist

5972221

Add intro and remove publishers metnion as all publishers are committers

3e07a05

Add links to Issues and PRs

5c24d9b

Changing the voice for publishers section and minor grammar in admins

7c19a69

styfle approved these changes Feb 27, 2018

View reviewed changes

joshbruce merged commit 953002c into markedjs:master Feb 27, 2018

Feder1co5oave mentioned this pull request Feb 27, 2018

Stepping down from developer #1093

Closed

zhenalexfan pushed a commit to zhenalexfan/MarkdownHan that referenced this pull request Nov 8, 2021

Merge pull request markedjs#1081 from joshbruce/update-readme

3347c45

Update docs

snyk-bot mentioned this pull request Apr 12, 2022

[Snyk] Security upgrade rollup-plugin-license from 2.3.0 to 2.7.0 ekmixon/marked#72

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update docs #1081

Update docs #1081

joshbruce commented Feb 25, 2018 •

edited

Loading

Feder1co5oave commented Feb 25, 2018

joshbruce commented Feb 25, 2018

joshbruce Feb 25, 2018

joshbruce Feb 25, 2018

styfle Feb 26, 2018

joshbruce Feb 26, 2018

joshbruce Feb 26, 2018

styfle Feb 26, 2018

joshbruce Feb 25, 2018

joshbruce Feb 25, 2018

joshbruce Feb 25, 2018 •

edited

Loading

joshbruce commented Feb 25, 2018 •

edited

Loading

styfle Feb 27, 2018

joshbruce Feb 27, 2018

Update docs #1081

Update docs #1081

Conversation

joshbruce commented Feb 25, 2018 • edited Loading

Description

Submitter

Reviewer

Feder1co5oave commented Feb 25, 2018

joshbruce commented Feb 25, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joshbruce Feb 25, 2018 • edited Loading

Choose a reason for hiding this comment

joshbruce commented Feb 25, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joshbruce commented Feb 25, 2018 •

edited

Loading

joshbruce Feb 25, 2018 •

edited

Loading

joshbruce commented Feb 25, 2018 •

edited

Loading