docbrown/docs
Shubhankar Kanchan Gupta a60c923539
new liquid tag - dotnetfiddle (#10788)
* new liquid tag - dotnetfiddle

* 1. Moved the hack into controller
2. Use URI to check if Widget keyword doesn't exist, then insert Widget using URI

* 1. Fixed tests
2. Updated code to eliminate xss_attacks

* Update app/liquid_tags/dotnet_fiddle_tag.rb to match pr comment

Co-authored-by: Michael Kohl <me@citizen428.net>

Co-authored-by: Michael Kohl <me@citizen428.net>
2020-10-16 14:47:52 -04:00
..
.static Update more Forem to DEV language (#9337) 2020-07-15 18:01:34 -04:00
admin [deploy] Move /internal to `/admin (#9639) 2020-08-07 10:36:26 -04:00
backend [deploy] Adds a new admin setting for experience levels. (#10870) 2020-10-16 12:40:25 -06:00
contributing Add gitdocs as devDependency (#9463) 2020-07-24 13:48:36 +02:00
creators Fix a typo caused by markdown (#9995) 2020-08-25 15:41:59 -04:00
design Add initial language doc page (#9653) 2020-08-06 14:46:04 -04:00
frontend new liquid tag - dotnetfiddle (#10788) 2020-10-16 14:47:52 -04:00
getting-started replace Envfile with env_sample and reference env file in auth docs (#10864) 2020-10-16 00:09:16 -05:00
installation [deploy] Adds a new admin setting for experience levels. (#10870) 2020-10-16 12:40:25 -06:00
maintainers Update more Forem to DEV language (#9337) 2020-07-15 18:01:34 -04:00
technical-overview Update feed docs (#10881) 2020-10-16 12:51:52 -04:00
tests Update docs with Forem instead of dev.to (#9316) 2020-07-15 13:29:11 -04:00
.gitdocs.json Update docs with Forem instead of dev.to (#9316) 2020-07-15 13:29:11 -04:00
.nvmrc Use Node lts/erbium (v12) for Netlify builds (#5925) 2020-02-06 12:03:11 -05:00
.ruby-version Change /settings/misc to /settings/ux (#7107) 2020-04-06 14:50:34 -04:00
api_template.hbs Update docs with Forem instead of dev.to (#9316) 2020-07-15 13:29:11 -04:00
api_v0.yml [deploy] Introduce /api/profile_images/:username endpoint (#10547) 2020-10-14 14:24:25 -05:00
faqs.md Add rails dbconsole (#10861) 2020-10-16 14:13:57 -04:00
Gemfile Upgrade Rubocop to 0.81 (#7219) 2020-04-11 10:10:04 +02:00
licensing.md Update more Forem to DEV language (#9337) 2020-07-15 18:01:34 -04:00
Makefile API: OpenAPI 3 spec and auto generated docs (#3650) 2019-08-12 11:36:04 -04:00
netlify.toml Fix Netlify catch all redirections (#9717) 2020-08-10 13:37:15 -04:00
readme.md [deploy] Move /internal to `/admin (#9639) 2020-08-07 10:36:26 -04:00
self-hosting.md Update more Forem to DEV language (#9337) 2020-07-15 18:01:34 -04:00
troubleshooting.md [deploy] Remove ENVied Gem, Use dotenv Take 2 (#9767) 2020-08-14 12:20:47 -05:00

items
technical-overview
installation
getting-started
contributing
backend
frontend
admin
design
tests
faqs.md
troubleshooting.md
licensing.md
self-hosting.md
maintainers
component
Divider
creators

Welcome to Forem's developer documentation

On this site you'll find instructions to setup a local instance of Forem, documentation on the architecture of Forem, how to contribute, and many other useful documents.

This documentation site is the product of a number of volunteer contributors working alongside the Forem Core Team, special thanks to all those who have contributed to the documentation.

Running the documentation locally

Like Forem, this site is open source and the code is hosted on GitHub. If you find any incorrect information, or a even a typo, we'd love to see a pull request. Follow these steps to get the documentation site running locally.

Forem's documentation is built with GitDocs NodeJS library.

To start the gitdocs server, you should run yarn gitdocs serve from the root of the forem project or from the /docs directory.

yarn gitdocs serve

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

If you add new pages or rename existing pages, you'll need to restart the server for those changes to take effect.

Contributing to the docs

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