add slash at beginning
This commit is contained in:
parent
3d357e9c18
commit
a17feb12d6
@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
|
|||||||
## Enforcement
|
## Enforcement
|
||||||
|
|
||||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||||
reported by contacting the project team by submitting a PR with changes to the [AUTHORS](#AUTHORS.md) page (or emailing josh@8fold.com). All
|
reported by contacting the project team by submitting a PR with changes to the [AUTHORS](#/AUTHORS.md) page (or emailing josh@8fold.com). All
|
||||||
complaints will be reviewed and investigated and will result in a response that
|
complaints will be reviewed and investigated and will result in a response that
|
||||||
is deemed necessary and appropriate to the circumstances. The project team is
|
is deemed necessary and appropriate to the circumstances. The project team is
|
||||||
obligated to maintain confidentiality with regard to the reporter of an incident.
|
obligated to maintain confidentiality with regard to the reporter of an incident.
|
||||||
|
@ -25,15 +25,15 @@ The following table lists the ticket type labels we use when there is work to be
|
|||||||
|Ticket type label |Description |
|
|Ticket type label |Description |
|
||||||
|:----------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|:----------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|L0 - security |A security vulnerability within the Marked library is discovered. |
|
|L0 - security |A security vulnerability within the Marked library is discovered. |
|
||||||
|L1 - broken |Valid usage results in incorrect output compared to [supported specifications](#README.md#specifications) OR causes marked to crash AND there is no known workaround for the issue. |
|
|L1 - broken |Valid usage results in incorrect output compared to [supported specifications](#/README.md#specifications) OR causes marked to crash AND there is no known workaround for the issue. |
|
||||||
|L2 - annoying |Similar to L1 - broken only there is a known workaround avaialable for the issue. |
|
|L2 - annoying |Similar to L1 - broken only there is a known workaround avaialable for the issue. |
|
||||||
|RR - refactor and re-engineer |Results in an improvement to developers using Marked (improved readability) or end-users (faster performance) or both. |
|
|RR - refactor and re-engineer |Results in an improvement to developers using Marked (improved readability) or end-users (faster performance) or both. |
|
||||||
|NFS - new feature (spec related) |A capability Marked does not currently provide but is in one of the [supported specifications](#README.md#specifications) |
|
|NFS - new feature (spec related) |A capability Marked does not currently provide but is in one of the [supported specifications](#/README.md#specifications) |
|
||||||
|NFU - new feature (user requested) |A capability Marked does not currently provide but has been requested by users of Marked. |
|
|NFU - new feature (user requested) |A capability Marked does not currently provide but has been requested by users of Marked. |
|
||||||
|
|
||||||
## Test early, often, and everything
|
## Test early, often, and everything
|
||||||
|
|
||||||
We try to write test cases to validate output (writing tests based on the [supported specifications](#README.md#specifications)) and minimize regression (writing tests for issues fixed). Therefore, if you would like to contribute, some things you should know regarding the test harness.
|
We try to write test cases to validate output (writing tests based on the [supported specifications](#/README.md#specifications)) and minimize regression (writing tests for issues fixed). Therefore, if you would like to contribute, some things you should know regarding the test harness.
|
||||||
|
|
||||||
|Location |Description |
|
|Location |Description |
|
||||||
|:-------------|:---------------------------------------------------|
|
|:-------------|:---------------------------------------------------|
|
||||||
@ -92,4 +92,4 @@ npm run build
|
|||||||
|
|
||||||
## Publishing
|
## Publishing
|
||||||
|
|
||||||
Creating GitHub releases and publishing to NPM is limited to conributors and owners. If you would like more information, please see our [publishing documentation](#PUBLISHING.md).
|
Creating GitHub releases and publishing to NPM is limited to conributors and owners. If you would like more information, please see our [publishing documentation](#/PUBLISHING.md).
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
# Releasing Marked
|
# Releasing Marked
|
||||||
|
|
||||||
- [ ] See [contributing](#CONTRIBUTING.md)
|
- [ ] See [contributing](#/CONTRIBUTING.md)
|
||||||
- [ ] Create release branch from `master` (`release-x.y.z`)
|
- [ ] Create release branch from `master` (`release-x.y.z`)
|
||||||
- [ ] Submit PR with minimal name: Release x.y.z
|
- [ ] Submit PR with minimal name: Release x.y.z
|
||||||
- [ ] Complete PR checklists
|
- [ ] Complete PR checklists
|
||||||
|
@ -70,7 +70,7 @@ $ cat hello.html
|
|||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
Marked offers [advanced configurations](#USING_ADVANCED.md) and [extensibility](#USING_PRO.md) as well.
|
Marked offers [advanced configurations](#/USING_ADVANCED.md) and [extensibility](#/USING_PRO.md) as well.
|
||||||
|
|
||||||
<h2 id="specifications">Supported Markdown specifications</h2>
|
<h2 id="specifications">Supported Markdown specifications</h2>
|
||||||
|
|
||||||
@ -88,17 +88,17 @@ By supporting the above Markdown flavors, it's possible that Marked can help you
|
|||||||
|
|
||||||
The only completely secure system is the one that doesn't exist in the first place. Having said that, we take the security of Marked very seriously.
|
The only completely secure system is the one that doesn't exist in the first place. Having said that, we take the security of Marked very seriously.
|
||||||
|
|
||||||
Therefore, please disclose potential security issues by email to the project [committers](#AUTHORS.md) as well as the [listed owners within NPM](https://docs.npmjs.com/cli/owner). We will provide an initial assessment of security reports within 48 hours and should apply patches within 2 weeks (also, feel free to contribute a fix for the issue).
|
Therefore, please disclose potential security issues by email to the project [committers](#/AUTHORS.md) as well as the [listed owners within NPM](https://docs.npmjs.com/cli/owner). We will provide an initial assessment of security reports within 48 hours and should apply patches within 2 weeks (also, feel free to contribute a fix for the issue).
|
||||||
|
|
||||||
<h2 id="contributing">Contributing</h2>
|
<h2 id="contributing">Contributing</h2>
|
||||||
|
|
||||||
The marked community enjoys a spirit of collaboration and contribution from all comers. Whether you're just getting started with Markdown, JavaScript, and Marked or you're a veteran with it all figured out, we're here to help each other improve as professionals while helping Marked improve technically. Please see our [contributing documentation](#CONTRIBUTING.md) for more details.
|
The marked community enjoys a spirit of collaboration and contribution from all comers. Whether you're just getting started with Markdown, JavaScript, and Marked or you're a veteran with it all figured out, we're here to help each other improve as professionals while helping Marked improve technically. Please see our [contributing documentation](#/CONTRIBUTING.md) for more details.
|
||||||
|
|
||||||
For our Contribution License Agreement, see our [license](https://github.com/markedjs/marked/blob/master/LICENSE.md).
|
For our Contribution License Agreement, see our [license](https://github.com/markedjs/marked/blob/master/LICENSE.md).
|
||||||
|
|
||||||
<h2 id="authors">Authors</h2>
|
<h2 id="authors">Authors</h2>
|
||||||
|
|
||||||
For list of credited authors and contributors, please see our [authors page](#AUTHORS.md).
|
For list of credited authors and contributors, please see our [authors page](#/AUTHORS.md).
|
||||||
|
|
||||||
<h2 id="license">License</h2>
|
<h2 id="license">License</h2>
|
||||||
|
|
||||||
|
@ -73,7 +73,7 @@
|
|||||||
<body>
|
<body>
|
||||||
<div id="container">
|
<div id="container">
|
||||||
<header>
|
<header>
|
||||||
<a href="#">
|
<a href="#/README.md">
|
||||||
<img src="img/logo-black.svg" height="64px" width="64px" />
|
<img src="img/logo-black.svg" height="64px" width="64px" />
|
||||||
</a>
|
</a>
|
||||||
<h1>Marked.js Documentation</h1>
|
<h1>Marked.js Documentation</h1>
|
||||||
@ -110,8 +110,8 @@
|
|||||||
|
|
||||||
var uri = hash.split('#');
|
var uri = hash.split('#');
|
||||||
|
|
||||||
if (uri[0].match('.md$')) {
|
if (uri[0].match(/^\//)) {
|
||||||
currentPage = uri[0];
|
currentPage = uri[0].slice(1);
|
||||||
if (uri.length > 1) {
|
if (uri.length > 1) {
|
||||||
currentHash = uri[1];
|
currentHash = uri[1];
|
||||||
} else {
|
} else {
|
||||||
@ -121,23 +121,23 @@
|
|||||||
currentHash = uri[0];
|
currentHash = uri[0];
|
||||||
}
|
}
|
||||||
|
|
||||||
fetchPage(currentPage)
|
fetchPage(currentPage).then(function () {
|
||||||
.then(function () {
|
fetchAnchor(currentHash)
|
||||||
if(currentHash) {
|
});
|
||||||
var hashElement = document.getElementById(currentHash);
|
|
||||||
if (hashElement) {
|
|
||||||
hashElement.scrollIntoView();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
history.replaceState('', document.title, '#' + currentPage + (currentHash ? '#' + currentHash : ''));
|
history.replaceState('', document.title, '#/' + currentPage + (currentHash ? '#' + currentHash : ''));
|
||||||
}
|
}
|
||||||
|
|
||||||
window.addEventListener('hashchange', function (e) {
|
function fetchAnchor(anchor) {
|
||||||
e.preventDefault();
|
if (!anchor) {
|
||||||
hashChange();
|
return;
|
||||||
});
|
}
|
||||||
|
|
||||||
|
var hashElement = document.getElementById(anchor);
|
||||||
|
if (hashElement) {
|
||||||
|
hashElement.scrollIntoView();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
function fetchPage(page) {
|
function fetchPage(page) {
|
||||||
if (page === renderedPage) {
|
if (page === renderedPage) {
|
||||||
@ -160,6 +160,11 @@
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
window.addEventListener('hashchange', function (e) {
|
||||||
|
e.preventDefault();
|
||||||
|
hashChange();
|
||||||
|
});
|
||||||
|
|
||||||
hashChange();
|
hashChange();
|
||||||
</script>
|
</script>
|
||||||
</body>
|
</body>
|
||||||
|
Loading…
x
Reference in New Issue
Block a user