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

[Markdown] Add support for YAML Header #294

Closed
wants to merge 1 commit into from

Conversation

GProulx
Copy link

@GProulx GProulx commented Oct 18, 2021

Hi @stkb !

Thanks for that great extension!

I currently use Markdown files with DocFx to generate documentation and YAML Header helps me keep extra information on markdown files.

Without this fix, rewrap generate something similar to that:

    ---                              ¦    ->      ---  ¦
    uid:                             ¦            uid: title: "High Level Architecture" ¦
    title: "High Level Architecture" ¦            ---  ¦            
    ---                              ¦            

So I created that PR to allow me to fully use your extension on whole documents.

Tests execution output:

(rewrap) C:\Code\GitHub\Rewrap>do test

Running Core tests
Passed: 249; Failed: 0; Errored: 0


(rewrap) C:\Code\GitHub\Rewrap>

Thanks.

@GProulx GProulx changed the title Supporting YAML Header [Markdown] Add support for YAML Header Oct 18, 2021
@stkb
Copy link
Owner

stkb commented Nov 11, 2021

Hi @GProulx! Thanks for this, though I decided it should be done, in a more "proper" way, i.e. making sure it the header only applies if it's at the top of the file. I've added it to some changes I was already working on.

It isn't yet in the current version, but you can try it if you like by downloading & installing v1.16.0-beta.1.

@stkb stkb closed this Nov 11, 2021
stkb added a commit that referenced this pull request Jan 14, 2022
- New architecture (still WIP) with performance increase.
- Markdown: new parser that fixes many small bugs (inc #288), as well as
  supporting:
  - Front matter header (#277, #294)
  - Link reference definitions (#63, #93)
  - Footnotes (#188)
- ReStructuredText support (standalone & for Python, almost complete)
  (#88).
- Julia: support `#= ... =#` block comments (#302)
- Visual Studio: Wrap to rulers generated from .editorconfig by the
  Editor Guidelines extension (thereby indirectly supporting
  .editorconfig) (#300).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants