Code Monkey home page Code Monkey logo

gitbook-plugin-code-captions's Introduction

MIT License npm version

Gitbook Plugin: Add captions to code snippets

Description

A simple gitbook plugin for adding captions or titles to code blocks.

This plugin is based on gitbook-plugin-codeblock-filename.

Installation

Add the plugin to your book.json:

{
	"plugins": [ "code-captions" ]
}

Then install it with gitbook:

gitbook install

Usage

Just add a !CAPTION sentence before the desired block:

!CAPTION This the hello_world.rb file
```ruby
puts "Hello world"
```

Generating the following result:

Sample

To override the CSS style, include this in your CSS files:

div.code-caption > span.code-caption-text {
  background-color: rgba(255, 0, 0, 0.07);
  /* Your css rules */
}

Generating the following result:

Custom sample

Contributors

This project has been developed by:

Avatar Name Nickname Email
Daniel Herzog Wikiti [email protected]

gitbook-plugin-code-captions's People

Contributors

wikiti avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.