Merge pull request #994 from aditmehta9/patch-4

Modified Scraper Ref. link

Jasper van Merle committed 7 years ago

Commit 51d4b672 parents 515b090 6906f361 file · +1 −1Browse files

Unified · Split

docs/adding-docs.md+1−1

@@ -3,7 +3,7 @@ Adding a documentation may look like a daunting task but once you get the hang o · 2 unmodified lines
3	Note: please read the [contributing guidelines](https://github.com/Thibaut/devdocs/blob/master/.github/CONTRIBUTING.md) before submitting a new documentation.	3	Note: please read the [contributing guidelines](https://github.com/Thibaut/devdocs/blob/master/.github/CONTRIBUTING.md) before submitting a new documentation.
4		4
5	1. Create a subclass of `Docs::UrlScraper` or `Docs::FileScraper` in the `lib/docs/scrapers/` directory. Its name should be the [PascalCase](http://api.rubyonrails.org/classes/String.html#method-i-camelize) equivalent of the filename (e.g. `my_doc` → `MyDoc`)	5	1. Create a subclass of `Docs::UrlScraper` or `Docs::FileScraper` in the `lib/docs/scrapers/` directory. Its name should be the [PascalCase](http://api.rubyonrails.org/classes/String.html#method-i-camelize) equivalent of the filename (e.g. `my_doc` → `MyDoc`)
6	2. Add the appropriate class attributes and filter options (see the [Scraper Reference](./scraper-reference.md) page).	6	2. Add the appropriate class attributes and filter options (see the [Scraper Reference](./Scraper-Reference.md) page).
7	3. Check that the scraper is listed in `thor docs:list`.	7	3. Check that the scraper is listed in `thor docs:list`.
8	4. Create filters specific to the scraper in the `lib/docs/filters/[my_doc]/` directory and add them to the class's [filter stacks](./scraper-reference.md#filter-stacks). You may create any number of filters but will need at least the following two:	8	4. Create filters specific to the scraper in the `lib/docs/filters/[my_doc]/` directory and add them to the class's [filter stacks](./scraper-reference.md#filter-stacks). You may create any number of filters but will need at least the following two:
9	* A [`CleanHtml`](./filter-reference.md#cleanhtmlfilter) filter whose task is to clean the HTML markup (e.g. adding `id` attributes to headings) and remove everything superfluous and/or nonessential.	9	* A [`CleanHtml`](./filter-reference.md#cleanhtmlfilter) filter whose task is to clean the HTML markup (e.g. adding `id` attributes to headings) and remove everything superfluous and/or nonessential.