Add prism support #325

alexearnshaw · 2020-08-14T07:58:20Z

Closes #292

This PR:

Adds Prism CSS and JS files with the Default Prism theme and the plugin that supports copy buttons on code samples to static folder
Adds references to the files to all pages via layouts/partials/head.html and layouts/partials/scripts.html
Adds a new config param for prism to config.toml (currently set to true for testing but will be set to false by default)
Add documentation for configuring Prism to the Docsy user guide

The deploy preview shows the theme in use in the Docsy user guide as a test (but this is not ready for merging yet!) See this page for an example https://deploy-preview-325--docsydocs.netlify.app/docs/getting-started/#using-the-docsy-theme-as-a-submodule

Also note that only the code blocks that have a language specified (including none) use Prism and have the copy buttons.

Prism requires you to download Prism JS/CSS files with the supported languages and plugins you want first, and then you add those to your project and reference them from your templates.

This PR adds a sensible default Prism CSS/JS which supports popular languages and copy buttons. This would mean all users get the copy buttons on code samples when they turn on the option in config.toml, but makes it so they can replace the default Prism files in Docsy theme with their own versions if they need more languages or other plugins. If the config.toml option is not enabled (the default) Prism is disabled and Chroma is used as before.

LisaFC · 2020-08-14T16:55:09Z

Oh this is great work! Re whether to make it the default, I'm inclined towards making it optional just because many of our users use particular Chroma styles/colour schemes in their sites.

Maybe send a mail to docsy-users@googlegroups.com and see what our users (or at least the ones who've joined the mailing list!) think?

alexearnshaw · 2020-08-14T17:51:17Z

I was thinking about this a bit more and I agree re leaving chroma as default. However I could add it with a default prism JS/CSS and then make it an off by default option in config.toml. At least that way if someone wants to use it they only have to turn the option on, and they only need to do additional work if they want to customize it further with different themes or plugins? Wdyt?

On Fri 14 Aug 2020 at 17:55, LisaFC ***@***.***> wrote: Oh this is great work! Re whether to make it the default, I'm inclined towards making it optional just because many of our users use particular Chroma styles/colour schemes in their sites. Maybe send a mail to ***@***.*** and see what our users (or at least the ones who've joined the mailing list!) think? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#325 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AG5X23AKV3ALHCQX6JH5TUTSAVT7XANCNFSM4P7HTBLA> . --

Alex Earnshaw "Only cat lovers know the luxury of fur-coated, musical hot water bottles that never go cold." - Susanne Millen

gwatts · 2020-08-14T17:59:16Z

for my 2¢, i like the suggestion off off by default, but with the lib supplied and ready to be enabled with a toggle - assuming the resulting files don't bloat the repo, and that the licenses are compatible with such distribution

google-cla · 2020-08-20T09:00:43Z

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.

What to do if you already signed the CLA

Individual signers

It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.

Corporate signers

Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
The email used to register you as an authorized contributor must also be attached to your GitHub account.

ℹ️ Googlers: Go here for more info.

alexearnshaw · 2020-08-20T09:09:34Z

@LisaFC This is ready for review now. I've gone with making it optional but easy to enable with sensible defaults after some feedback from the mailing list.

I've updated the PR description with full details. I've left the config option on for testing but it should be set to false before this is merged.

alexearnshaw · 2020-08-20T09:10:47Z

@googlebot I signed it!

LisaFC · 2020-09-02T16:39:50Z

Thanks Alex! Was a bit snowed under with other stuff but I'll take a look this week.

MarckK · 2020-09-05T21:45:50Z

Would love to see this in Docsy 👍

Thank you, @alexearnshaw.

LisaFC · 2020-09-10T14:23:38Z

Sorry this took so long, was busy in work and then sick - but this is fantastic Alex! Instructions in the docs seem clear. Merging it now. I will do a little announcement on the Twitter feed, do you want to mail the Docsy-users group to let them know it's available?

alexearnshaw · 2020-09-10T18:49:34Z

No problem @LisaFC but I think I left the config param turned on in last commit :( it should be turned off so the default is still chroma. Can you change that please? Also I think I need to do a PR to add the new config param to docsy example right?

LisaFC · 2020-09-10T19:13:17Z

No worries, I spotted that just after I merged and switched it off. And yes, please add the config param to the example project (it'll still work but otherwise users will have to type the whole thing in to their config)! Thanks again!

relates to google/docsy#325

* Update _index.html * Update _index.html * Update _index.html * Update _index.html * Update _index.html * Use new community template * Update _index.html * Update _index.html * Update _index.html * Update _index.html * any ould resources * Update _index.html * Rename _index.html to _index.md * Update _index.md * Update _index.md * Update _index.md * Doc section reorg, Docsy-fying, and updated instructions * Update theme module * Update theme module * Generalized blog text. Removed files that might cause confusion. * Minor tweaks to instructions * Update README.md * Create LICENSE * added disclaimer to README * removed generated resources folder * Add license boilerplate * add contributing guide * Update README.md Fixed repo names in README * Removed submodule * Added up to date theme module * Update config.toml updated theme name * Update _index.md * Update _index.md Remind users that sudo apt-get install hugo gets you a Very Old Version * Update README.md * Fix workaround instructions * Update _index.md Mention minimum Hugo version for Netlify * Update config.toml * Update _index.html * Update README.md * Update _index.md * Rename _index.md to .._index.md * Rename content/en/docs/How-tos/.._index.md to content/en/docs/Tasks/_index.md * Rename content/en/docs/How-tos/knitting-paragraphs.md to content/en/docs/Tasks/knitting-paragraphs.md * Rename content/en/docs/How-tos/weaving-words.md to content/en/docs/Tasks/weaving-words.md * Rename content/en/docs/How-tos/Ponycopters/_index.md to content/en/docs/Tasks/Ponycopters/_index.md * Rename content/en/docs/How-tos/Ponycopters/configuring-ponycopters.md to content/en/docs/Tasks/Ponycopters/configuring-ponycopters.md * Rename content/en/docs/How-tos/Ponycopters/launching-ponycopters.md to content/en/docs/Tasks/Ponycopters/launching-ponycopters.md * improved favicon instructions * update theme submodule * Fixed a typo and some code formatting. * More detail on landing pages and templates * Info on updating the theme * Update _index.md * Update _index.md * Fixing a badly used shortcode... * Update _index.md * Update README.md * update config to demonstrate feedback widget * s/ocassionally/occasionally/ * s/ocasionally/occasionally/ * Updating theme submodule * Linking to the staged website from the README. * Fixing broken link to example repository. * Clarified where to find the user guide. * Updating theme submodule * Adding resources * Adding instructions * Goldydocs rebranding part one... * More content updates/simplification/porridgification * Updated tasks page * Improved overview instructions * Contribution guidelines * Contribution guidelines * Updating theme submodule * Making the templatey nature more explicit * Updated example getting started page * Fix default baseURL or things go weird with absolute URLs in menus.... * Update config.toml * Update config.toml * Bump js-yaml from 3.12.1 to 3.13.1 Bumps [js-yaml](https://github.com/nodeca/js-yaml) from 3.12.1 to 3.13.1. - [Release notes](https://github.com/nodeca/js-yaml/releases) - [Changelog](https://github.com/nodeca/js-yaml/blob/master/CHANGELOG.md) - [Commits](nodeca/js-yaml@3.12.1...3.13.1) Signed-off-by: dependabot[bot] <support@github.com> * Update config.toml Co-Authored-By: RichieEscarez <rescarez@google.com> * Update config.toml Co-Authored-By: RichieEscarez <rescarez@google.com> * Updating theme submodule * tiny change for github subdir * small change to github subdir * remove redundant resources folder * Update README.md * Update README.md Removed reference to nonexistent theme docs in this repo * removing redundant files * Update config.toml * Added links to user guide repo * 404 page * Update _index.md * Changing placekitten links to be https * Update _index.html * Adding missing title to README.md * updating theme * Update README.md * Bump lodash from 4.17.11 to 4.17.14 Bumps [lodash](https://github.com/lodash/lodash) from 4.17.11 to 4.17.14. - [Release notes](https://github.com/lodash/lodash/releases) - [Commits](lodash/lodash@4.17.11...4.17.14) Signed-off-by: dependabot[bot] <support@github.com> * Add config option for about link in footer I needed a way to disable the About link in the footer and discovered this option by looking in the code. It's working for my site using the Docsy theme so I thought other people might benefit from knowing about it. * Change the value to false Changed the value to false so the Docsy example site is not affected * Move images to params.images * Bump mixin-deep from 1.3.1 to 1.3.2 Bumps [mixin-deep](https://github.com/jonschlinkert/mixin-deep) from 1.3.1 to 1.3.2. - [Release notes](https://github.com/jonschlinkert/mixin-deep/releases) - [Commits](jonschlinkert/mixin-deep@1.3.1...1.3.2) Signed-off-by: dependabot[bot] <support@github.com> * Updating theme submodule * Update config.toml Add a param for Algolia docsearch, related to PR on Docsy theme google/docsy#127 * Adding offlineSearch param As requested in https://github.com/google/docsy/pull/142/files#r338549380 * Bump packages with CVEs * Create search-index.md * Updating theme submodule * Update _index.md * Let Goldmark render raw HTML * Remove div that's confusing Goldmark Fixes google/docsy#174 * Added parameters for version banner. * Updating theme submodule * Updating theme submodule * Remove a unnecessary file (content/en/search-index.md) * Add reading time parameter * Updating theme submodule * Fix typo descripton -> description * point to google/docsy-example instead * update package.json and package-lock.json + Update dev dependencies to latest versions. (I confirmed that running `hugo server` and viewing the site works as expected.) + Fix URLs in package file. Fixes #45. * Create dependabot.yml Help keep the dev dependencies up to date. https://dependabot.com/#how-it-works * fixing typo * Bump lodash from 4.17.15 to 4.17.19 Bumps [lodash](https://github.com/lodash/lodash) from 4.17.15 to 4.17.19. - [Release notes](https://github.com/lodash/lodash/releases) - [Commits](lodash/lodash@4.17.15...4.17.19) Signed-off-by: dependabot[bot] <support@github.com> * Update config.toml Update to work with latest Chroma style support * Updating theme submodule * Updating theme submodule * Bump autoprefixer from 9.8.0 to 9.8.6 Bumps [autoprefixer](https://github.com/postcss/autoprefixer) from 9.8.0 to 9.8.6. - [Release notes](https://github.com/postcss/autoprefixer/releases) - [Changelog](https://github.com/postcss/autoprefixer/blob/master/CHANGELOG.md) - [Commits](postcss/autoprefixer@9.8.0...9.8.6) Signed-off-by: dependabot[bot] <support@github.com> * add dockerfile and change readme with instructions to build and run the docker image * Bump postcss-cli from 7.1.1 to 7.1.2 Bumps [postcss-cli](https://github.com/postcss/postcss-cli) from 7.1.1 to 7.1.2. - [Release notes](https://github.com/postcss/postcss-cli/releases) - [Changelog](https://github.com/postcss/postcss-cli/blob/master/CHANGELOG.md) - [Commits](postcss/postcss-cli@7.1.1...7.1.2) Signed-off-by: dependabot[bot] <support@github.com> * Updating theme submodule * Add config param for prism relates to google/docsy#325 * Set the prism option to false by default * Fixing broken links * Updating Docsy submodule * Updating theme submodule * Update docsy theme & enable 'print entire section' * Add persian translations. * Update README.md Add template instructions * Updating theme submodule * 🏗️ Dockerfile + docker-compose.yaml build/running Add Dockerfile for building with the latest and the docker-compose, building the site and running. $ docker-compose up Starting docsy-example_site_1 ... done Attaching to docsy-example_site_1 site_1 | Start building sites … site_1 | site_1 | | FA | NO | EN site_1 | -------------------+----+----+----- site_1 | Pages | 18 | 76 | 46 site_1 | Paginator pages | 0 | 0 | 0 site_1 | Non-page files | 3 | 1 | 3 site_1 | Static files | 38 | 38 | 38 site_1 | Processed images | 8 | 2 | 7 site_1 | Aliases | 3 | 0 | 3 site_1 | Sitemaps | 2 | 1 | 1 site_1 | Cleaned | 0 | 0 | 0 site_1 | site_1 | Built in 837 ms site_1 | Watching for changes in /src/{assets,content,layouts,package.json,themes} site_1 | Watching for config changes in /src/config.toml, /src/themes/docsy/config.toml site_1 | Environment: "DEV" site_1 | Serving pages from memory site_1 | Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender site_1 | Web Server is available at //localhost:1313/ (bind address 0.0.0.0) site_1 | Press Ctrl+C to stop Open a new terminal and test it $ curl -X HEAD -i localhost:1313 Warning: Setting custom HTTP method to HEAD with -X/--request may not work the Warning: way you want. Consider using -I/--head instead. HTTP/1.1 200 OK Accept-Ranges: bytes Content-Length: 27590 Content-Type: text/html; charset=utf-8 Last-Modified: Thu, 17 Dec 2020 08:47:13 GMT Date: Thu, 17 Dec 2020 08:47:25 GMT * Update to latest Docsy * Add a troubleshooting section. Error building site: TOCSS: failed to transform "scss/main.scss" (text/x-scss): resource "scss/scss/main. Solution: install hugo-extended Signed-off-by: Gaurav Gahlot <gauravgahlot0107@gmail.com> * Update README.md * 🐳 Dockerfile: Use the repo name as image tag * 📝 README: add steps with docker-compose Running with docker-compose is simpler for this case * Update Docker Compose instructions. * Fix indentation * Make cleanup steps a subsection * Add github_branch * Dockerfile: use base image with extended version of Hugo * Update search engine Fixes google/docsy#479 * Bump y18n from 4.0.0 to 4.0.1 Bumps [y18n](https://github.com/yargs/y18n) from 4.0.0 to 4.0.1. - [Release notes](https://github.com/yargs/y18n/releases) - [Changelog](https://github.com/yargs/y18n/blob/master/CHANGELOG.md) - [Commits](https://github.com/yargs/y18n/commits) Signed-off-by: dependabot[bot] <support@github.com> * Dockerfile: use klakegg/hugo:ext-alpine * Bump lodash from 4.17.20 to 4.17.21 Bumps [lodash](https://github.com/lodash/lodash) from 4.17.20 to 4.17.21. - [Release notes](https://github.com/lodash/lodash/releases) - [Commits](lodash/lodash@4.17.20...4.17.21) Signed-off-by: dependabot[bot] <support@github.com> * Bump browserslist from 4.14.0 to 4.16.6 Bumps [browserslist](https://github.com/browserslist/browserslist) from 4.14.0 to 4.16.6. - [Release notes](https://github.com/browserslist/browserslist/releases) - [Changelog](https://github.com/browserslist/browserslist/blob/main/CHANGELOG.md) - [Commits](browserslist/browserslist@4.14.0...4.16.6) Signed-off-by: dependabot[bot] <support@github.com> * Bump glob-parent from 5.1.1 to 5.1.2 Bumps [glob-parent](https://github.com/gulpjs/glob-parent) from 5.1.1 to 5.1.2. - [Release notes](https://github.com/gulpjs/glob-parent/releases) - [Changelog](https://github.com/gulpjs/glob-parent/blob/main/CHANGELOG.md) - [Commits](gulpjs/glob-parent@v5.1.1...v5.1.2) --- updated-dependencies: - dependency-name: glob-parent dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> * Bump postcss from 7.0.32 to 7.0.36 Bumps [postcss](https://github.com/postcss/postcss) from 7.0.32 to 7.0.36. - [Release notes](https://github.com/postcss/postcss/releases) - [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md) - [Commits](postcss/postcss@7.0.32...7.0.36) --- updated-dependencies: - dependency-name: postcss dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> * Updating theme submodule * Update config.toml * Updating theme submodule * Add taxonomy sample code Enable taxonomoy in `config.toml` and add tags and categories to the FrontMatter in the "Getting Started" docs. * Add navbar_translucent_over_cover_disable and sort ui elements * Delete package-lock.json and ignore it * Add a netlify.toml and update HUGO_VERSION * Update package.json: postcss* * Flip incorrect boolean in comment Fixes #141 * README: add link to deploy-logs * Min version of Node is latest LTS version * Add link to official Netlify dashboard * Bump autoprefixer from 9.8.8 to 10.4.0 Bumps [autoprefixer](https://github.com/postcss/autoprefixer) from 9.8.8 to 10.4.0. - [Release notes](https://github.com/postcss/autoprefixer/releases) - [Changelog](https://github.com/postcss/autoprefixer/blob/main/CHANGELOG.md) - [Commits](postcss/autoprefixer@9.8.8...10.4.0) --- updated-dependencies: - dependency-name: autoprefixer dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> * Bump postcss-cli from 8.3.1 to 9.0.2 Bumps [postcss-cli](https://github.com/postcss/postcss-cli) from 8.3.1 to 9.0.2. - [Release notes](https://github.com/postcss/postcss-cli/releases) - [Changelog](https://github.com/postcss/postcss-cli/blob/master/CHANGELOG.md) - [Commits](postcss/postcss-cli@8.3.1...9.0.2) --- updated-dependencies: - dependency-name: postcss-cli dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> * Bumped docsy theme to latest version * examples, api and intro docs * Tutorial 1 first draft * tutorials 2 and 3 * more cleanup * tutorial 2 and feedback page * tutorial 3 cleanup * release 1.0 js prep * add generated typescript version * use shortcode to allow serving from subdirectory like in github pages * update generated typescript docs for relative image locations Co-authored-by: LisaFC <lcarey@google.com> Co-authored-by: rionam <rionam@google.com> Co-authored-by: Lisa Carey <lcarey@rodete-desktop-gce-imager2.corp.google.com> Co-authored-by: Sarah Maddox <sarahmaddox@google.com> Co-authored-by: Kayce Basques <kayce@google.com> Co-authored-by: Kayce Basques <kaycebasques@gmail.com> Co-authored-by: Aijamal NK <aizhamal.nk@gmail.com> Co-authored-by: Andrew Chen <chenopis@users.noreply.github.com> Co-authored-by: Sharif Salah <sharifsalah@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: RichieEscarez <rescarez@google.com> Co-authored-by: Erin McKean <emckean@google.com> Co-authored-by: Kshithij Iyer <kshithij.ki@gmail.com> Co-authored-by: Alex Earnshaw <aearnshaw@axway.com> Co-authored-by: Yamagishi Kazutoshi <ykzts@desire.sh> Co-authored-by: Fabrizio Ferri-Benedetti <algernon@gmail.com> Co-authored-by: Austin Macdonald <austin@redhat.com> Co-authored-by: Sarah Maddox <sarahmaddox@users.noreply.github.com> Co-authored-by: Takayama Fumihiko <tekezo@pqrs.org> Co-authored-by: Lisa Carey <lcarey@lcarey-macbookpro.roam.corp.google.com> Co-authored-by: Ulf Adams <ulfjack@users.noreply.github.com> Co-authored-by: Daniel Holbach <daniel@weave.works> Co-authored-by: Jeff Williams <jefesaurus@google.com> Co-authored-by: Christian Oliff <christianoliff@pm.me> Co-authored-by: Christoph Raaflaub <raaflaub@puzzle.ch> Co-authored-by: Geri Ochoa <gerino@protonmail.com> Co-authored-by: Alex Earnshaw <alex.earnshaw@gmail.com> Co-authored-by: Andreas Deininger <adeininger@gmail.com> Co-authored-by: Gareth Watts <gareth@omnipotent.net> Co-authored-by: theSinner <amirajorloo@gmail.com> Co-authored-by: Marcello de Sales <marcello.desales@gmail.com> Co-authored-by: Gaurav Gahlot <gauravgahlot0107@gmail.com> Co-authored-by: Daan Seynaeve <daan.seynaeve@openanalytics.eu> Co-authored-by: Patrice Chalin <pchalin@gmail.com> Co-authored-by: Mark Hansen <markhansen@google.com> Co-authored-by: Andreas Deininger <adeininger@urbanonline.de> Co-authored-by: Sean Levin <slevin@yahooinc.com>

* Update _index.md * Rename _index.md to .._index.md * Rename content/en/docs/How-tos/.._index.md to content/en/docs/Tasks/_index.md * Rename content/en/docs/How-tos/knitting-paragraphs.md to content/en/docs/Tasks/knitting-paragraphs.md * Rename content/en/docs/How-tos/weaving-words.md to content/en/docs/Tasks/weaving-words.md * Rename content/en/docs/How-tos/Ponycopters/_index.md to content/en/docs/Tasks/Ponycopters/_index.md * Rename content/en/docs/How-tos/Ponycopters/configuring-ponycopters.md to content/en/docs/Tasks/Ponycopters/configuring-ponycopters.md * Rename content/en/docs/How-tos/Ponycopters/launching-ponycopters.md to content/en/docs/Tasks/Ponycopters/launching-ponycopters.md * improved favicon instructions * update theme submodule * Fixed a typo and some code formatting. * More detail on landing pages and templates * Info on updating the theme * Update _index.md * Update _index.md * Fixing a badly used shortcode... * Update _index.md * Update README.md * update config to demonstrate feedback widget * s/ocassionally/occasionally/ * s/ocasionally/occasionally/ * Updating theme submodule * Linking to the staged website from the README. * Fixing broken link to example repository. * Clarified where to find the user guide. * Updating theme submodule * Adding resources * Adding instructions * Goldydocs rebranding part one... * More content updates/simplification/porridgification * Updated tasks page * Improved overview instructions * Contribution guidelines * Contribution guidelines * Updating theme submodule * Making the templatey nature more explicit * Updated example getting started page * Fix default baseURL or things go weird with absolute URLs in menus.... * Update config.toml * Update config.toml * Bump js-yaml from 3.12.1 to 3.13.1 Bumps [js-yaml](https://github.com/nodeca/js-yaml) from 3.12.1 to 3.13.1. - [Release notes](https://github.com/nodeca/js-yaml/releases) - [Changelog](https://github.com/nodeca/js-yaml/blob/master/CHANGELOG.md) - [Commits](nodeca/js-yaml@3.12.1...3.13.1) Signed-off-by: dependabot[bot] <support@github.com> * Update config.toml Co-Authored-By: RichieEscarez <rescarez@google.com> * Update config.toml Co-Authored-By: RichieEscarez <rescarez@google.com> * Updating theme submodule * tiny change for github subdir * small change to github subdir * remove redundant resources folder * Update README.md * Update README.md Removed reference to nonexistent theme docs in this repo * removing redundant files * Update config.toml * Added links to user guide repo * 404 page * Update _index.md * Changing placekitten links to be https * Update _index.html * Adding missing title to README.md * updating theme * Update README.md * Bump lodash from 4.17.11 to 4.17.14 Bumps [lodash](https://github.com/lodash/lodash) from 4.17.11 to 4.17.14. - [Release notes](https://github.com/lodash/lodash/releases) - [Commits](lodash/lodash@4.17.11...4.17.14) Signed-off-by: dependabot[bot] <support@github.com> * Add config option for about link in footer I needed a way to disable the About link in the footer and discovered this option by looking in the code. It's working for my site using the Docsy theme so I thought other people might benefit from knowing about it. * Change the value to false Changed the value to false so the Docsy example site is not affected * Move images to params.images * Bump mixin-deep from 1.3.1 to 1.3.2 Bumps [mixin-deep](https://github.com/jonschlinkert/mixin-deep) from 1.3.1 to 1.3.2. - [Release notes](https://github.com/jonschlinkert/mixin-deep/releases) - [Commits](jonschlinkert/mixin-deep@1.3.1...1.3.2) Signed-off-by: dependabot[bot] <support@github.com> * Updating theme submodule * Update config.toml Add a param for Algolia docsearch, related to PR on Docsy theme google/docsy#127 * Adding offlineSearch param As requested in https://github.com/google/docsy/pull/142/files#r338549380 * Bump packages with CVEs * Create search-index.md * Updating theme submodule * Update _index.md * Let Goldmark render raw HTML * Remove div that's confusing Goldmark Fixes google/docsy#174 * Added parameters for version banner. * Updating theme submodule * Updating theme submodule * Remove a unnecessary file (content/en/search-index.md) * Add reading time parameter * Updating theme submodule * Fix typo descripton -> description * point to google/docsy-example instead * update package.json and package-lock.json + Update dev dependencies to latest versions. (I confirmed that running `hugo server` and viewing the site works as expected.) + Fix URLs in package file. Fixes #45. * Create dependabot.yml Help keep the dev dependencies up to date. https://dependabot.com/#how-it-works * fixing typo * Bump lodash from 4.17.15 to 4.17.19 Bumps [lodash](https://github.com/lodash/lodash) from 4.17.15 to 4.17.19. - [Release notes](https://github.com/lodash/lodash/releases) - [Commits](lodash/lodash@4.17.15...4.17.19) Signed-off-by: dependabot[bot] <support@github.com> * Update config.toml Update to work with latest Chroma style support * Updating theme submodule * Updating theme submodule * Bump autoprefixer from 9.8.0 to 9.8.6 Bumps [autoprefixer](https://github.com/postcss/autoprefixer) from 9.8.0 to 9.8.6. - [Release notes](https://github.com/postcss/autoprefixer/releases) - [Changelog](https://github.com/postcss/autoprefixer/blob/master/CHANGELOG.md) - [Commits](postcss/autoprefixer@9.8.0...9.8.6) Signed-off-by: dependabot[bot] <support@github.com> * add dockerfile and change readme with instructions to build and run the docker image * Bump postcss-cli from 7.1.1 to 7.1.2 Bumps [postcss-cli](https://github.com/postcss/postcss-cli) from 7.1.1 to 7.1.2. - [Release notes](https://github.com/postcss/postcss-cli/releases) - [Changelog](https://github.com/postcss/postcss-cli/blob/master/CHANGELOG.md) - [Commits](postcss/postcss-cli@7.1.1...7.1.2) Signed-off-by: dependabot[bot] <support@github.com> * Updating theme submodule * Add config param for prism relates to google/docsy#325 * Set the prism option to false by default * Fixing broken links * Updating Docsy submodule * Updating theme submodule * Update docsy theme & enable 'print entire section' * Add persian translations. * Update README.md Add template instructions * Updating theme submodule * 🏗️ Dockerfile + docker-compose.yaml build/running Add Dockerfile for building with the latest and the docker-compose, building the site and running. $ docker-compose up Starting docsy-example_site_1 ... done Attaching to docsy-example_site_1 site_1 | Start building sites … site_1 | site_1 | | FA | NO | EN site_1 | -------------------+----+----+----- site_1 | Pages | 18 | 76 | 46 site_1 | Paginator pages | 0 | 0 | 0 site_1 | Non-page files | 3 | 1 | 3 site_1 | Static files | 38 | 38 | 38 site_1 | Processed images | 8 | 2 | 7 site_1 | Aliases | 3 | 0 | 3 site_1 | Sitemaps | 2 | 1 | 1 site_1 | Cleaned | 0 | 0 | 0 site_1 | site_1 | Built in 837 ms site_1 | Watching for changes in /src/{assets,content,layouts,package.json,themes} site_1 | Watching for config changes in /src/config.toml, /src/themes/docsy/config.toml site_1 | Environment: "DEV" site_1 | Serving pages from memory site_1 | Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender site_1 | Web Server is available at //localhost:1313/ (bind address 0.0.0.0) site_1 | Press Ctrl+C to stop Open a new terminal and test it $ curl -X HEAD -i localhost:1313 Warning: Setting custom HTTP method to HEAD with -X/--request may not work the Warning: way you want. Consider using -I/--head instead. HTTP/1.1 200 OK Accept-Ranges: bytes Content-Length: 27590 Content-Type: text/html; charset=utf-8 Last-Modified: Thu, 17 Dec 2020 08:47:13 GMT Date: Thu, 17 Dec 2020 08:47:25 GMT * Update to latest Docsy * Add a troubleshooting section. Error building site: TOCSS: failed to transform "scss/main.scss" (text/x-scss): resource "scss/scss/main. Solution: install hugo-extended Signed-off-by: Gaurav Gahlot <gauravgahlot0107@gmail.com> * Update README.md * 🐳 Dockerfile: Use the repo name as image tag * 📝 README: add steps with docker-compose Running with docker-compose is simpler for this case * Update Docker Compose instructions. * Fix indentation * Make cleanup steps a subsection * Add github_branch * Dockerfile: use base image with extended version of Hugo * Update search engine Fixes google/docsy#479 * Bump y18n from 4.0.0 to 4.0.1 Bumps [y18n](https://github.com/yargs/y18n) from 4.0.0 to 4.0.1. - [Release notes](https://github.com/yargs/y18n/releases) - [Changelog](https://github.com/yargs/y18n/blob/master/CHANGELOG.md) - [Commits](https://github.com/yargs/y18n/commits) Signed-off-by: dependabot[bot] <support@github.com> * Dockerfile: use klakegg/hugo:ext-alpine * Bump lodash from 4.17.20 to 4.17.21 Bumps [lodash](https://github.com/lodash/lodash) from 4.17.20 to 4.17.21. - [Release notes](https://github.com/lodash/lodash/releases) - [Commits](lodash/lodash@4.17.20...4.17.21) Signed-off-by: dependabot[bot] <support@github.com> * Bump browserslist from 4.14.0 to 4.16.6 Bumps [browserslist](https://github.com/browserslist/browserslist) from 4.14.0 to 4.16.6. - [Release notes](https://github.com/browserslist/browserslist/releases) - [Changelog](https://github.com/browserslist/browserslist/blob/main/CHANGELOG.md) - [Commits](browserslist/browserslist@4.14.0...4.16.6) Signed-off-by: dependabot[bot] <support@github.com> * Bump glob-parent from 5.1.1 to 5.1.2 Bumps [glob-parent](https://github.com/gulpjs/glob-parent) from 5.1.1 to 5.1.2. - [Release notes](https://github.com/gulpjs/glob-parent/releases) - [Changelog](https://github.com/gulpjs/glob-parent/blob/main/CHANGELOG.md) - [Commits](gulpjs/glob-parent@v5.1.1...v5.1.2) --- updated-dependencies: - dependency-name: glob-parent dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> * Bump postcss from 7.0.32 to 7.0.36 Bumps [postcss](https://github.com/postcss/postcss) from 7.0.32 to 7.0.36. - [Release notes](https://github.com/postcss/postcss/releases) - [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md) - [Commits](postcss/postcss@7.0.32...7.0.36) --- updated-dependencies: - dependency-name: postcss dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> * Updating theme submodule * Update config.toml * Updating theme submodule * Add taxonomy sample code Enable taxonomoy in `config.toml` and add tags and categories to the FrontMatter in the "Getting Started" docs. * Add navbar_translucent_over_cover_disable and sort ui elements * Delete package-lock.json and ignore it * Add a netlify.toml and update HUGO_VERSION * Update package.json: postcss* * Flip incorrect boolean in comment Fixes #141 * README: add link to deploy-logs * Min version of Node is latest LTS version * Add link to official Netlify dashboard * Bump autoprefixer from 9.8.8 to 10.4.0 Bumps [autoprefixer](https://github.com/postcss/autoprefixer) from 9.8.8 to 10.4.0. - [Release notes](https://github.com/postcss/autoprefixer/releases) - [Changelog](https://github.com/postcss/autoprefixer/blob/main/CHANGELOG.md) - [Commits](postcss/autoprefixer@9.8.8...10.4.0) --- updated-dependencies: - dependency-name: autoprefixer dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> * Bump postcss-cli from 8.3.1 to 9.0.2 Bumps [postcss-cli](https://github.com/postcss/postcss-cli) from 8.3.1 to 9.0.2. - [Release notes](https://github.com/postcss/postcss-cli/releases) - [Changelog](https://github.com/postcss/postcss-cli/blob/master/CHANGELOG.md) - [Commits](postcss/postcss-cli@8.3.1...9.0.2) --- updated-dependencies: - dependency-name: postcss-cli dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> * config.toml: replace tabs with whitespace * Bumped docsy theme to latest version * README.md: correct dead link (installing/using themes) (#160) * config.toml: change order of language settings and theme/module declaration (#162) * Updating docsy theme submodule (#164) * config.toml: comment typo: s/lang/length I don't think taxonomyCloud has a language, and I think they need to have the same length, so I think this is what was intended. * Leave param name unqualified in comment * Make docsy example site use docsy theme as hugo module (#156) * docsy as module: refer to current HEAD of repo (#169) * Remove outdated deployment script (#170) * Update example site to docsy theme v0.2.0 (#171) * README.md: reflect changes due to use of theme as hugo module (#172) * Checkpoint for Kubeflow on AWS 1.4 docs staging 4/12 7:47pm * Finished About section organization * Fixed AWS logos and updated docs structure * AWS-specific doc restructuring * About page notes update * Added prereq page and deployment drafts * Added Profiles component guide * Restructured Deployment docs for KF on AWS website * Syncing About, Deployment, and Components section * Added AWS Labs kubeflow-manifests doc issue template to feedback prompt * Staged Uninstall deployment doc * Fixed Uninstall relative links * Move all files into src/website directory * Cleaned up extra files * Added website working directory to kubeflow-manifests repo * Added Hugo Docsy theme submodule * Testing GitHub actions build * Modified Config file for testing * Removed GH actions test * Added PostCSS dependency * GH actions test #2 * GH actions test #3 * Restructured deployment pages * Updated RDS&S3, EFS, and FSx installation guides based on recent PRs * Reverted file structure and refreshed EFS/FSx/RDS&S3 docs * GH actions test * Removed GH workflows script * Minimized docs pages for website staging * Load balancer installation guide refresh * Updated Usage Tracking command for KF on AWS * Finished uninstall and RDS S3 pages * Finished vanilla guide edits * Deployment PR feedback and link fixes Co-authored-by: LisaFC <lcarey@google.com> Co-authored-by: Sarah Maddox <sarahmaddox@google.com> Co-authored-by: Kayce Basques <kayce@google.com> Co-authored-by: Kayce Basques <kaycebasques@gmail.com> Co-authored-by: Aijamal NK <aizhamal.nk@gmail.com> Co-authored-by: Andrew Chen <chenopis@users.noreply.github.com> Co-authored-by: Sharif Salah <sharifsalah@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: RichieEscarez <rescarez@google.com> Co-authored-by: Erin McKean <emckean@google.com> Co-authored-by: Kshithij Iyer <kshithij.ki@gmail.com> Co-authored-by: Alex Earnshaw <aearnshaw@axway.com> Co-authored-by: Yamagishi Kazutoshi <ykzts@desire.sh> Co-authored-by: Fabrizio Ferri-Benedetti <algernon@gmail.com> Co-authored-by: Austin Macdonald <austin@redhat.com> Co-authored-by: Sarah Maddox <sarahmaddox@users.noreply.github.com> Co-authored-by: Takayama Fumihiko <tekezo@pqrs.org> Co-authored-by: Lisa Carey <lcarey@lcarey-macbookpro.roam.corp.google.com> Co-authored-by: Ulf Adams <ulfjack@users.noreply.github.com> Co-authored-by: Daniel Holbach <daniel@weave.works> Co-authored-by: Jeff Williams <jefesaurus@google.com> Co-authored-by: Christian Oliff <christianoliff@pm.me> Co-authored-by: Christoph Raaflaub <raaflaub@puzzle.ch> Co-authored-by: Geri Ochoa <gerino@protonmail.com> Co-authored-by: Alex Earnshaw <alex.earnshaw@gmail.com> Co-authored-by: Andreas Deininger <adeininger@gmail.com> Co-authored-by: Gareth Watts <gareth@omnipotent.net> Co-authored-by: theSinner <amirajorloo@gmail.com> Co-authored-by: Marcello de Sales <marcello.desales@gmail.com> Co-authored-by: Gaurav Gahlot <gauravgahlot0107@gmail.com> Co-authored-by: Daan Seynaeve <daan.seynaeve@openanalytics.eu> Co-authored-by: Patrice Chalin <pchalin@gmail.com> Co-authored-by: Mark Hansen <markhansen@google.com> Co-authored-by: Andreas Deininger <adeininger@urbanonline.de> Co-authored-by: Andreas Deininger <andreas@deininger.net> Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>

alexearnshaw added 2 commits August 13, 2020 16:28

adding prism wip

8b31618

add more info

e5c9830

move prism code and use default prism files

9c95e1e

LisaFC mentioned this pull request Aug 19, 2020

Ability to change syntax highlighting #291

Closed

Add more default langs, update user guide

9179c8b

alexearnshaw marked this pull request as ready for review August 20, 2020 09:07

MarckK mentioned this pull request Sep 7, 2020

add a copy button to code examples jenkins-x/jx-docs#3049

Closed

LisaFC merged commit ce90c17 into google:master Sep 10, 2020

kbhawkey mentioned this pull request Sep 18, 2020

fix copy to clipboard kubernetes/website#23966

Merged

alexearnshaw added a commit to alexearnshaw/docsy-example that referenced this pull request Sep 19, 2020

Add config param for prism

d899fba

relates to google/docsy#325

alexearnshaw mentioned this pull request Sep 19, 2020

Add config param for prism google/docsy-example#76

Merged

This was referenced Sep 29, 2020

Code Copy Buttons knative/website#57

Open

Apply Docsy updates from the upstream knative/website#226

Merged

chalin mentioned this pull request Feb 11, 2023

Reactivate code-block copy feature #1267

Closed

This was referenced Oct 2, 2023

[Snyk] Fix for 1 vulnerabilities CF-GG/docsy#4

Open

[Snyk] Fix for 1 vulnerabilities MaxMood96/docsy#70

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add prism support #325

Add prism support #325

alexearnshaw commented Aug 14, 2020 •

edited

Loading

LisaFC commented Aug 14, 2020

alexearnshaw commented Aug 14, 2020 via email

gwatts commented Aug 14, 2020

google-cla bot commented Aug 20, 2020

alexearnshaw commented Aug 20, 2020 •

edited

Loading

alexearnshaw commented Aug 20, 2020

LisaFC commented Sep 2, 2020

MarckK commented Sep 5, 2020

LisaFC commented Sep 10, 2020

alexearnshaw commented Sep 10, 2020

LisaFC commented Sep 10, 2020

Add prism support #325

Add prism support #325

Conversation

alexearnshaw commented Aug 14, 2020 • edited Loading

LisaFC commented Aug 14, 2020

alexearnshaw commented Aug 14, 2020 via email

gwatts commented Aug 14, 2020

google-cla bot commented Aug 20, 2020

What to do if you already signed the CLA

Individual signers

Corporate signers

alexearnshaw commented Aug 20, 2020 • edited Loading

alexearnshaw commented Aug 20, 2020

LisaFC commented Sep 2, 2020

MarckK commented Sep 5, 2020

LisaFC commented Sep 10, 2020

alexearnshaw commented Sep 10, 2020

LisaFC commented Sep 10, 2020

alexearnshaw commented Aug 14, 2020 •

edited

Loading

alexearnshaw commented Aug 20, 2020 •

edited

Loading