docbrown/docs
rhymes 8989a52aba Strip EXIF and GPS data from uploaded images (#4450)
* Add specs for ArticleImageUploader

* Add specs for BadgeUploader

* Add specs for CoverImageUploader

* Add specs for ProfileImageUploader

* Refactor uploaders to inherit from BaseUploader

* Strip EXIF and GPS data from uploaded images

* Add ImageMagick to the docs

* Protect strip_exif
2019-10-24 16:35:10 -04:00
..
.static VS Code Settings Update / Frontend Debug Documentation (#4346) 2019-10-10 13:10:03 -04:00
backend Add a sentence to clarify GitHub Authentication (#4360) 2019-10-11 08:56:02 -04:00
design Add new font and theme config, plus new navbar config option (#4462) 2019-10-24 08:38:46 -04:00
frontend Fix typo in liquid tags docs (#4533) 2019-10-22 10:07:54 -04:00
getting-started Doc: Fix/clarify getting started docs (#4509) [ci skip] 2019-10-22 14:38:41 -04:00
installation Strip EXIF and GPS data from uploaded images (#4450) 2019-10-24 16:35:10 -04:00
tests Fix typos and mechanical mistakes (#4177) [ci skip] 2019-10-01 16:30:13 -04:00
.gitdocs.json API: OpenAPI 3 spec and auto generated docs (#3650) 2019-08-12 11:36:04 -04:00
.ruby-version Adds Ruby source code documentation to docs.dev.to (#2656) 2019-05-02 13:50:58 -04:00
api_template.hbs Use server side comments for templates (#4123) 2019-09-27 10:10:30 -04:00
api_v0.yml Fix API inconsistencies between articles 'index' and 'show' (#4560) 2019-10-24 11:56:55 -04:00
contributing.md Update the docs readme with instructions [ci skip] (#4361) 2019-10-14 09:24:46 -04:00
contributing_api.md Add info about bumping API version to docs.dev (#4454) 2019-10-16 09:04:36 -04:00
deploy-script.js Update Docs deploy command (#3940) 2019-09-04 09:29:49 -04:00
deployment.md Create doc on deployment CI/CD process (#4563) [ci skip] 2019-10-24 15:24:02 -04:00
faqs.md Fix typos and mechanical mistakes (#4177) [ci skip] 2019-10-01 16:30:13 -04:00
Gemfile Upgrade rubocop and rubocop-performance (#2802) [ci skip] 2019-05-13 19:21:24 -04:00
licensing.md Doc: Add mailto link in licensing.md (#4440) [ci skip] 2019-10-24 15:45:28 -04:00
Makefile API: OpenAPI 3 spec and auto generated docs (#3650) 2019-08-12 11:36:04 -04:00
readme.md Create doc on deployment CI/CD process (#4563) [ci skip] 2019-10-24 15:24:02 -04:00
self-hosting.md Fix typos and mechanical mistakes (#4177) [ci skip] 2019-10-01 16:30:13 -04:00
technical-overview.md Strip EXIF and GPS data from uploaded images (#4450) 2019-10-24 16:35:10 -04:00

items
technical-overview.md
installation
getting-started
backend
frontend
design
deployment.md
tests
contributing.md
contributing_api.md
faqs.md
licensing.md
self-hosting.md

Welcome to DEV's developer documentation

Here you can find instructions on how to setup your own local copy of DEV, how to navigate the code, how to contribute, and how to troubleshoot issues, among other things.

Running the documentation locally

DEV's documentation is built with GitDocs NodeJS library.

The first step to running the documentations it locally is to install the GitDocs package globally.

With npm:

npm install gitdocs -g

Alternatively, you can use Yarn:

yarn global add gitdocs

Once installed, you can run gitdocs serve from the root of the dev.to project or from the /docs directory.

gitdocs serve

This will start a server where you can browse the documentation: http://localhost:8000/

When you add new markdown pages or rename existing ones, you'll have to restart the server before you notice any changes.

Contributing to the docs

If you're looking for more information on contributing, check out the Contributing article.