-
Notifications
You must be signed in to change notification settings - Fork 88
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add English docs to repo * Update PR template to mention documentation requirement * Add guide markdown linting
- Loading branch information
1 parent
aa8ecb6
commit 4accf36
Showing
5 changed files
with
29 additions
and
192 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,36 @@ | ||
# Rollupjs.org | ||
|
||
This is the source code for the website! | ||
This is the source code for the website. Note that the actual guide is now part of the [main rollup repo](https://github.com/rollup/rollup/tree/master/guide) and needs to be updated there, see below. | ||
|
||
## Steps to build the website locally | ||
|
||
1. `npm install` | ||
2. `npm run dev` | ||
3. Open up http://localhost:3000 | ||
|
||
|
||
## Adding translations | ||
|
||
Translations into other languages are warmly welcomed. Make a copy of the `guide/en` directory, renaming it to your language (e.g. `guide/fr`), and update the markdown files inside. Once done, the translation will be available at `/[lang]`. | ||
2. `npm run update-guide` | ||
3. `npm run dev` | ||
4. Open up http://localhost:3000 | ||
|
||
## Updating the guide contents | ||
|
||
The guide is part of the main rollup repo, which again is added to this repo in form of a submodule. Running `npm run update-guide` should automatically initialize the submodule and copy the latest guide into a local folder. To update the guide contents: | ||
|
||
1. Update the guide in a fork or a branch (if you have access rights) of the main rollup repo and make a pull request. Pull requests that add or modify features should always update the guide as well. | ||
2. Once it is merged, check out the latest master branch in the submodule: | ||
```bash | ||
cd rollup-submodule | ||
git checkout master | ||
git pull | ||
``` | ||
3. Commit the new branch in the main repo: | ||
```bash | ||
cd .. | ||
git add rollup-submodule | ||
git commit -m "Update guide" | ||
``` | ||
|
||
Steps 2 and 3 should be done by the person merging the pull request in the main rollup repo. Once the commit has been pushed to `origin/master`, the website should be updated by the CI automatically. If necessary instead of checking out latest master, it is also possible to check out any other commit to e.g. test a pull request. | ||
|
||
## Style Guidelines | ||
|
||
_(Note: This section will be updated on an as-needed basis)_ | ||
|
||
- Please use `-` for bulleted list items. | ||
- Please set a preferred line length of 100 characters in your editor for Markdown files in this repository. | ||
- Please do not use hard line breaks to format blocks of plain text. Rather, please enable soft-line breaks in your editor. | ||
- Please do not use hard line breaks to format blocks of plain text. Rather, please enable soft-line breaks in your editor. |
This file was deleted.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Submodule rollup-submodule
updated
14 files
+1 −1 | .github/PULL_REQUEST_TEMPLATE.md | |
+1 −1 | docs/00-introduction.md | |
+0 −0 | docs/01-command-line-reference.md | |
+0 −0 | docs/02-javascript-api.md | |
+0 −0 | docs/03-es-module-syntax.md | |
+0 −0 | docs/04-tutorial.md | |
+0 −0 | docs/05-plugins.md | |
+0 −0 | docs/06-faqs.md | |
+0 −0 | docs/07-tools.md | |
+0 −0 | docs/08-troubleshooting.md | |
+0 −0 | docs/999-big-list-of-options.md | |
+4 −0 | markdownlint.json | |
+144 −0 | package-lock.json | |
+6 −2 | package.json |