Skip to content

Add npm run icon: fetch a doc's icon from its website #2781

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
buggypather wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add npm run icon: fetch a doc's icon from its website #2781

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/adding-docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Adding a documentation may look like a daunting task but once you get the hang o
8. Tweak the scraper/filters and repeat 5) and 6) until the pages and metadata are ok. Only the first run downloads the pages; the ones after that are served from the [response cache](./scraper-reference.md#response-cache), until you run `thor docs:clean`.
9. To customize the pages' styling, create an SCSS file in the `assets/stylesheets/pages/` directory and import it in `application.css.scss`. Both the file and CSS class should be named `_[type]` where [type] is equal to the scraper's `type` attribute (documentations with the same type share the same custom CSS and JS). Setting the type to `simple` will apply the general styling rules in `assets/stylesheets/pages/_simple.scss`, which can be used for documentations where little to no CSS changes are needed.
10. To add syntax highlighting or execute custom JavaScript on the pages, create a file in the `assets/javascripts/views/pages/` directory (take a look at the other files to see how it works).
11. Add the documentation's icon in the `public/icons/docs/[my_doc]/` directory, in both 16x16 and 32x32-pixels formats. The icon spritesheet is automatically generated when you (re)start your local DevDocs instance.
11. Add the documentation's icon in the `public/icons/docs/[my_doc]/` directory, in both 16x16 and 32x32-pixels formats. The icon spritesheet is automatically generated when you (re)start your local DevDocs instance. `npm run icon -- [my_doc] [website]` downloads the website's icon and saves it there in both sizes, with a `SOURCE` file giving where it came from; check that it looks right at 16 pixels. If the website only offers an SVG icon, save a PNG of it online and add `--icon [image address]`.
12. Add the documentation's copyright details to `options[:attribution]`. This is the data shown in the table on the [about](https://devdocs.io/about) page, and is ordered alphabetically. Please see an existing scraper for the typesetting.
13. Ensure `thor updates:check [my_doc]` shows the correct latest version.

Expand Down
5 changes: 3 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
"private": true,
"type": "module",
"scripts": {
"test": "node --import ./test/assets/setup.js --test test/assets/*_test.js",
"typecheck": "tsc -p tsconfig.json && tsc -p test/assets/tsconfig.json"
"test": "node --import ./test/assets/setup.js --test test/assets/*_test.js test/scripts/*_test.js",
"icon": "node scripts/fetch_icon.js",
"typecheck": "tsc -p tsconfig.json && tsc -p test/assets/tsconfig.json && tsc -p test/scripts/tsconfig.json"
},
"devDependencies": {
"@types/node": "^24.9.2",
Expand Down
Loading