Lightning fast zero dependency library for embedding gists on your webpage
npm install gist-embedLightning fast zero dependency library for embedding gists on your webpage.
``html`
src="https://cdn.jsdelivr.net/npm/gist-embed@1.0.3/dist/gist-embed.min.js"
>
`html`
- You can add an object with settings to window.GistEmbedSettings before you include the gist-embed script tagbaseURL
- Settings supported:
- : Specify a base url used to fetch the gist. Defaults to https://gist.github.com.window.GistEmbed.init()
- You can run the init to parse the elements at any time. This is useful when your code element is added after the script tag include has already parsed the elements on page load.
- : This will parse all the elements again that have a data-gist-id attribute.
You can add attributes to your HTML Element that modify the gist embed.
- data-gist-hide-line-numbers
- type: string
- Removes all of the line numbers in the left hand gutter of the gist
-
- type: string
- Removes the gist footer
-
- type: string
- Places a header above the gist with your chosen caption string
-
- type: string
- If the gist has multiple files, specify the filename you want to show
-
- type: string
- Line numbers you want to show. The rest are removed.
- Examples:
- // Only shows lines 1, 2 and 31-4
- // Only shows lines 1, 2, 3, and 41-4,8
- // Only shows lines 1, 2, 3, 4, and 8data-gist-highlight
-
- type: string
- Line numbers you want to highlight. Uses the same syntax for line ranges as
- I recommend using VSCode to develop
- Install prettier VSCode extension
- npm install
- To start the dev server: npm run dev
- This starts webpack with a local web server and hot reloading
- navigate to http://localhost:8080/
- webpack serves the compiled TypeScript to /dist/gist-embed.min.js when in development mode
- Please add unit tests for your new code.
- npm test
- Use methods to get access to private functions in index.ts. See tests/index.test.js for examples.index.html
- Add an example to
- Update the README with the new jsdelivr script based on new version bump
- Husky, a git hook tool, will automatically lint and run prettier when you git commit` as well as run jest tests and create the prod minified bundle.
- My old github account couldn't be recovered, so starting with a new repo here.
- I always wanted to rewrite gist-embed to not use jQuery and simplify the code.
- Going forward, this will be where all gist-embed code will reside.
- That account will probably go away soon. If you really need to rely on it, I suggest forking it before it's removed.
- This will be a plain vanilla JS library from now on.
- The gists should load much faster now that we are removing jQuery as a dependency.
- Lesson learned - always keep up to date 2FA recovery codes if you have 2FA enabled on your account and lose your authentication app :(