From 606ec7b34e053ad3bcdd09797c5008c78af21446 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hero=E2=84=A2?= Date: Tue, 3 Apr 2018 07:18:37 +0800 Subject: [PATCH] Update README.md Fixed Previous File --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 29e44d99..8385543b 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Keep track of development news: :bookmark_tabs: **Table of Contents:** [Quick Start](#quick-start) · [Vision](#vision) · [App](#app) · [Scraper](#scraper) · [Commands](#available-commands) · [Contributing](#contributing) · [License](#copyright--license) · [Questions?](#questions) -##:zap: Quick Start +## :zap: Quick Start Unless you wish to contribute to the project, I recommend using the hosted version at [devdocs.io](https://devdocs.io). It's up-to-date and works offline out-of-the-box. @@ -46,7 +46,7 @@ docker build -t thibaut/devdocs . docker run --name devdocs -d -p 9292:9292 thibaut/devdocs ``` -##:trophy: Vision +## :trophy: Vision DevDocs aims to make reading and searching reference documentation fast, easy and enjoyable. @@ -54,7 +54,7 @@ The app's main goals are to: keep load times as short as possible; improve the q :bulb: **Note:** DevDocs is neither a programming guide nor a search engine. All our content is pulled from third-party sources and the project doesn't intend to compete with full-text search engines. Its backbone is metadata; each piece of content is identified by a unique, "obvious" and short string. Tutorials, guides and other content that don't meet this requirement are outside the scope of the project. -##:iphone: App +## :iphone: App The web app is all client-side JavaScript, written in [CoffeeScript](http://coffeescript.org), and powered by a small [Sinatra](http://www.sinatrarb.com)/[Sprockets](https://github.com/rails/sprockets) application. It relies on files generated by the [scraper](#scraper). @@ -75,7 +75,7 @@ DevDocs being a developer tool, the browser requirements are high: This allows the code to take advantage of the latest DOM and HTML5 APIs and make developing DevDocs a lot more fun! -##:mag_right: Scraper +## :mag_right: Scraper The scraper is responsible for generating the documentation and index files(metadata) used by the [app](#app). It's written in Ruby under the `Docs` module. @@ -95,7 +95,7 @@ The end result is a set of normalized HTML partials and two JSON files (index + More information about scrapers and filters is available on the [wiki](https://github.com/freeCodeCamp/devdocs/wiki). -##:computer: Available Commands +## :computer: Available Commands The command-line interface uses [Thor](http://whatisthor.com). To see all commands and options, run `thor list` from the project's root. @@ -131,13 +131,13 @@ thor assets:clean # Clean old assets If multiple versions of Ruby are installed on your system, commands must be run through `bundle exec`. -##:bar_chart: Contributing +## :bar_chart: Contributing Contributions are welcome. Please read the [contributing guidelines](https://github.com/freeCodeCamp/devdocs/blob/master/CONTRIBUTING.md). DevDocs's own documentation is available on the [wiki](https://github.com/freeCodeCamp/devdocs/wiki). -##:clipboard: Copyright / License +## :clipboard: Copyright / License Copyright 2013-2018 Thibaut Courouble and [other contributors](https://github.com/freeCodeCamp/devdocs/graphs/contributors) @@ -147,6 +147,6 @@ Please do not use the name DevDocs to endorse or promote products derived from t I also wish that any documentation file generated using this software be attributed to DevDocs. Let's be fair to all contributors by giving credit where credit's due. Thanks! -##:email: Questions? +## :email: Questions? If you have any questions, please feel free to ask them on the [mailing list](https://groups.google.com/d/forum/devdocs).