https://github.com/alexwforsythe/code-blocks
Syntax highlighting for Google Docs
https://github.com/alexwforsythe/code-blocks
google-apps-script google-docs-addon syntax-highlighting
Last synced: 25 days ago
JSON representation
Syntax highlighting for Google Docs
- Host: GitHub
- URL: https://github.com/alexwforsythe/code-blocks
- Owner: alexwforsythe
- License: mit
- Created: 2016-09-19T19:22:28.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-09-14T19:05:06.000Z (over 1 year ago)
- Last Synced: 2024-10-30T07:45:28.564Z (6 months ago)
- Topics: google-apps-script, google-docs-addon, syntax-highlighting
- Language: JavaScript
- Homepage: https://www.alexwforsythe.com/code-blocks/
- Size: 727 KB
- Stars: 706
- Watchers: 15
- Forks: 90
- Open Issues: 134
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/google/clasp) [](https://paypal.me/alexwforsythe)
# Usage
## Starting the add-on
## Formatting inline code
## Formatting code blocks
## Reformatting code blocks
## Previewing themes
Examples of the different color themes applied to various languages can be
found on the [highlight.js demo page](https://highlightjs.org/static/demo/).
## Unformatting code
To clear formatting in Docs, highlight the text and select
`Format > Clear Formatting` from the toolbar. The keyboard shortcut is
Cmd+/ on OS X and Ctrl+/ on
Windows:
https://support.google.com/docs/answer/179738
This will not remove the table that the text lives in if it's a "code block".
To do that, you'll have to copy the text and paste it outside the table, then
right-click the table and select **Delete table**.
# Limitations
## Updates to syntax highlighting
Code Blocks is built with [highlight.js](https://highlightjs.org/) and can only
provide syntax highlighting for languages that are supported by that library.
If you'd like to see Code Blocks support a language that is not yet implemented
by highlight.js, please refer to [their page on requesting new languages](http://highlightjs.readthedocs.io/en/latest/language-requests.html).
If you'd like to see Code Blocks update or fix support for an existing language:
1. Check if the [latest version of highlight.js](https://github.com/highlightjs/highlight.js/releases)
already includes the update. If it does, submit a PR to this repository that
bumps the highlight.js version in [`package.json`](https://github.com/alexwforsythe/code-blocks/blob/master/package.json).
2. If highlight.js does not yet include the update, please submit an issue on
[their issue tracker](https://github.com/highlightjs/highlight.js/issues).
## Real-time syntax highlighting
Codes Blocks uses Google's
[Apps Script](https://developers.google.com/apps-script/), a server-side
JavaScript platform, to interact with Docs and format code. Each time the add-on
formats a snippet of code, a request is made to the Apps Script backend to
modify the current Doc. There are a few limitations of this platform that
prevent Code Blocks from formatting code as you type:
* The [`onEdit`](https://developers.google.com/apps-script/guides/triggers#onedite)
event that fires when a user modifies content is only available in Sheets
* [Time-driven triggers](https://developers.google.com/apps-script/guides/triggers/installable#time-driven_triggers)
can only be used once per hour at most
* Each request to modify the current Doc can take multiple seconds, so code
formatting cannot be performed in real-time
* The number of requests needed to update a Doc in near real-time may exceed
the service API quotas
## Keyboard Shortcuts
Keyboard shortcuts can only be handled by Code Blocks if the add-on sidebar is
focused, which would require users to click the sidebar anyway.
Keyboard events in the active document cannot currently be handled by Docs
add-ons:
https://issuetracker.google.com/issues/79461369
# Contributing
## Setup
```
$ npm install
```
## Building
```
$ npm run build
```
## Pushing Changes
ℹ️ The following commands only work for the project maintainer
because they require Google Drive authorization.
| Command | Description |
| --- | --- |
| `npm run push:gas` | just GAS files |
| `npm run push:js` | just `sidebar.js` |
| `npm run push:static` | just HTML & CSS |
| `npm run push` | everything |
# Google Apps Script Resources
* https://developers.google.com/apps-script/guides/clasp
* https://github.com/google/clasp/blob/master/docs/typescript.md
* https://developers.google.com/apps-script/guides/support/best-practices
* https://gsuite-developers.googleblog.com/2015/12/advanced-development-process-with-apps.html
* http://googleappsscript.blogspot.com/2010/06/optimizing-spreadsheet-operations.html
---
[Homepage](https://www.alexwforsythe.com/code-blocks/) | [Google Workspace Marketplace](https://workspace.google.com/marketplace/app/code_blocks/100740430168) | [Privacy Policy](https://www.alexwforsythe.com/code-blocks/privacy-policy) | [Terms of Service](https://www.alexwforsythe.com/code-blocks/terms-of-service)