Comments (5)
I personally prefer British spelling, and use that in documentation. I do use US spelling for code though. Above all consistency is most important. The reason for this API case is that this library was originally authored by a UK citizen.
I think behavior
would be better here. Although Iām very much against unneeded breaking changes, we can:
- Update the docs to use
behavior
- Update the code to use
behavior
but fall back tobehaviour
ifbehavior
is not given - Cut a minor release
from remark-autolink-headings.
Agreed! I can work on this, if you'd like.
Should we also add some kind of warning when behaviour
is used?
If so, is console.warn(someMessage)
sufficient? I don't know what's standard.
from remark-autolink-headings.
Sounds good, Node does something similar (docs and source)
console.warn
looks like a nice, light weight approach š (browser compatibility)
from remark-autolink-headings.
As far as I know the remark ecosystem leans towards American spelling but at this point I don't think it's worth a breaking change on its own.
from remark-autolink-headings.
Console.warn is nice enough but I'd still be slightly annoyed by those appearing from a minor update?
I would Def be for a comment that says something like 'remove next major'.
But I'm up for what everyone else things, no strong feelings!
from remark-autolink-headings.
Related Issues (13)
- Emoji leads to weird slug HOT 12
- Links are not added to headings
- Compatible with `remark-slug` version 5 HOT 2
- Bug: version 5.0.0 on npm is outdated HOT 3
- Add behavoir for fixed headers. HOT 9
- Support ignoring headings HOT 9
- Links should either be labeled or removed from tabbing HOT 7
- `contentDefaults` must have `children: []`
- latin char id link problem HOT 4
- No Id, No href attribute HOT 1
- Generated link anchor doesn't have an icon HOT 1
- Include example on how to style <span class="icon icon-link"> HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
š Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. ššš
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ā¤ļø Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from remark-autolink-headings.