Giter VIP home page Giter VIP logo

expressjs.com's Introduction

expressjs.com

This is the repository of the website expressjs.com. It is hosted directly from the repository as a GitHub Pages website.

Local Setup

To preview the website locally:

  1. Install Ruby and Bundler if you don't have them already.

  2. Install the jekyll-redirect-from gem:

$ gem install jekyll-redirect-from
  1. cd to the repository directory and run the following command:
$ cd expressjs.com
$ bundle install

Bundler will look in the Gemfile for which gems to install. The github-pages gem includes the same version of Jekyll and other dependencies as used by GitHub Pages, so that your local setup mirrors GitHub Pages as closely as possible.

Run Jekyll using the following command:

$ bundle exec jekyll serve

Then, load http://localhost:4000/ on your browser.

Formatting

Jekyll uses a variant of Markdown known as Kramdown.

Jekyll uses the Liquid template engine for templating.

You can use http://kramdown.gettalong.org/parser/gfm.html fenced code blocks for JavaScript; for example:

var express = require('express')
var app = express()
app.listen(3000)

The default GitHub Pages syntax highlighting has been disabled in `_config.yml to allow highlighting with prism.js.

Contributing

Feel free to make changes to the template files or the document files. The supporting docs are located in their respective directories, and the API docs are located under the _includes directory.

Please see the Contributors' Guide for more information on contributing to the documentation, including information on contributing translations.

Why use Jekyll instead of an Express-based solution?

Jekyll comes built-in with GitHub Pages. Since we are already using GitHub Pages to host the website, it makes sense to leverage the capabilities it provides. It's all about using the right tool, for the right job, under the right circumstances.

expressjs.com's People

Contributors

afucher avatar alanhoff avatar altsang avatar alvarotrigo avatar blainsmith avatar brunowego avatar crandmck avatar dangelzm avatar davidyang avatar defunctzombie avatar dougwilson avatar freethejazz avatar gidenilson avatar hacksparrow avatar iamropo avatar jonathanong avatar jordonias avatar karaokeresearch avatar kevinhu-1024 avatar linusu avatar madarche avatar martinerko avatar oskosk avatar rafael-franca avatar ritch avatar ryush00 avatar tj avatar v-e-y avatar vitaly-t avatar zackdever avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.