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

Allow to generate lower case header references through the config #205

Merged
merged 2 commits into from Oct 23, 2019

Conversation

@hoijui
Copy link
Contributor

hoijui commented Oct 22, 2019

Allow to generate lower case header references through the config

This makes the references consistent/compatible with GitHub,
GitLab, Pandoc and many other tools.

This behavior can be enabled in config.json with:

"linkifyHeaderStyle": "gfm"

See the related issue on HackMd.

hoijui added 2 commits Oct 21, 2019
Signed-off-by: hoijui <hoijui.quaero@gmail.com>
This makes the references consistent/compatible with GitHub,
GitLab, Pandoc and many other tools.

This behavior can be enabled in config.json with:

```
"linkifyHeaderStyle": "gfm"
```

Signed-off-by: hoijui <hoijui.quaero@gmail.com>
@SISheogorath

This comment has been minimized.

Copy link
Member

SISheogorath commented Oct 22, 2019

On one hand I like the idea, at the same time, I see tons of links breaking when we enable this by default.

I guess we should think about storing this kind of configs along with the documents.

@hoijui

This comment has been minimized.

Copy link
Contributor Author

hoijui commented Oct 22, 2019

though the same. :/
That s why it is off by default, and needs to be explicitly enabled as described, through the config.

@SISheogorath

This comment has been minimized.

Copy link
Member

SISheogorath commented Oct 22, 2019

Oh seems like I mixed up the defaults and the docs setting when I skimmed over the changes. Nice!

@hoijui

This comment has been minimized.

Copy link
Contributor Author

hoijui commented Oct 22, 2019

...ouh I just saw that I have gfm in config.json.example, meaning for new installs, it would be the default. Is that ok?

@SISheogorath

This comment has been minimized.

Copy link
Member

SISheogorath commented Oct 22, 2019

Yes, I'm don't think it's a problem for new setups :) Just existing once shouldn't break.

@SISheogorath SISheogorath merged commit 7a27579 into codimd:master Oct 23, 2019
4 checks passed
4 checks passed
DCO DCO
Details
WIP Ready for review
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
security/snyk - package.json (codimd) No manifest changes detected
@hoijui hoijui referenced this pull request Oct 30, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.