Skip to content

Latest commit

 

History

History
110 lines (51 loc) · 4.17 KB

README.md

File metadata and controls

110 lines (51 loc) · 4.17 KB
Raw

definitelytyped.github.io

Website content for definitelytyped.org.

The master branch holds live github.io content generated from the source branch.

The site build with Grunt and generated using docpad, a static site generator complete with watch tasks, development server with LiveReload and many plugins.

Edit online

  1. Use the github web interface to quickly make text edits like updating the guides and the directory. Github will create a fork and you can modify content without leaving your browser.

  2. The content is saved as markdown and located in ./src/documents.

Bulk editing

If you like to use your own tools you can follow these steps:

  1. Fork the repository.

  2. Checkout the source branch.

  3. If you already have a checkout make sure you pull the latest revision.

  4. Locate the content your want to change in ./src/documents. Most of the editable content is in markdown format (some with a .eco template filter).

  5. Make your edits and commit your changes. A flat commit with sensible commit-note is appreciated.

  6. Push to your changes to your fork.

  7. Send a pull request to the source branch.

  8. After review a committer will merge and GitHub Actions will republish the site.

  9. See below for the steps to get a local preview (this is not essential for simple markdown edits).

Edit the site

To do structural authoring with a build-preview you can follow the development flow.

Working with the site is done using your commandline terminal and should work on any platform. So it can be bash, shell, cmd.exe or anything else (like WebStorm embedded terminal).

Prerequisites

  1. Get node.js (> 0.10.0) for your local platform, it comes with the npm package manager.

  2. Have the global grunt cli command: run npm install grunt-cli -g in your command line.

  3. You dont need a global docpad install; it comes as local dependency.

Get the project

  1. Fork the repository (or just clone if you got commit access).

  2. Checkout the source branch.

  3. Run npm install to pull all local dependencies. (this can take a minute)

Do some work in the project

Use grunt to run various commands.

  1. The main tasks are:

    1. Run grunt clean - remove all generated content.

    2. Run grunt watch - regenerate and start a watch with LiveReload server at http://localhost:9778/

    3. Run grunt build - regenerate the site for production environment (best to stop the watch if you have it active).

    4. Run grunt publish - build and push to github master (live at definitelytyped.org). This will ask for your github credentials so you need commit access to the repository (otherwise send a PR with the your source). Make sure you also push the changes to source.

    5. See grunt -h or the Gruntfile.js for additional commands.

Publish the changes

  1. Push your changes to the source branch (or send a pull request).

  2. If you like some feedback first then use a fork (or branch).

  3. The every commit that lands on source will automatically be rebuild and deployed via GitHub Actions.

  4. Give GitHub Actions a minute or two to deploy the site, then verify your changes.

  5. Optional: Fix some typos.

Notes:

  1. If you build or watch the content then you might get some yellow warning's in the console. These can usually be ignored when docpad telling us that some transforms didn't have any effect: this is correct if you use a template transform (.eco) but have no template fields in the file (yet).

  2. ⚠️ Direct changes to master branch will be overwritten or discarded so always edit through source!

Contributions

Contributions are welcome! Check the website for more info, then return here and follow the instructions above.

License

Copyright (c) 2014 DefinitelyTyped

Licensed under the MIT license.