Skip to content

Instantly share code, notes, and snippets.

View plaindocs's full-sized avatar
🌏
Looking for work

Sam plaindocs

🌏
Looking for work
View GitHub Profile
@MattiooFR
MattiooFR / indent2fence.py
Last active November 12, 2021 13:55
This little program convert all the indented code blocks in a markdown file to a fenced code blocks style.
"""
This little program convert all the indented code blocks
in a markdown file to a fenced code blocks style.
It adds python language highlight argument by default.
This program is argely inspired by the php gist made by tobice
https://gist.github.com/tobice/1beab9616bb48e56ac1f1eb48c11dd97
-p, --path : path to the file to convert
-t, --type : change the language highlight for the code blocks
@briandominick
briandominick / doc-ops-consulting-agreement.adoc
Last active July 19, 2022 17:29
Sample DocOps Consulting Agreement (Prime Source)

Documentation Engineering Consulting Agreement

@andychase
andychase / googleforms2slack.gs
Last active February 15, 2024 07:53
Google Forms Slack Notification
// Google Forms Slack Notification
// Andy Chase <github.com/andychase>
// License: CC0 1.0 Universal <creativecommons.org/publicdomain/zero/1.0>
// Install 1: This code goes in ( tools > script editor... ) of your google docs form
// Install 2: ( resources > current project triggers ) ( [onSubmit], [from Form], [On form submit] )
// Setup 1: Put your slack api url below
var POST_URL = "https://hooks.slack.com/services/";
function onSubmit(e) {
@brson
brson / gist:9470739
Last active February 15, 2016 04:15
Rust doc hacking cheatsheet

Tips for hacking on Rust docs in the Rust tree

Standalone docs

  • make doc/tutorial.html - build the tutorial
  • make check-stage1-doc-tutorial - test the examples in the tutorial

API docs

  • make doc/std/index.html - build the API docs for std
=begin
Jekyll tag to include Markdown text from _includes directory preprocessing with Liquid.
Usage:
{% markdown <filename> %}
=end
module Jekyll
class MarkdownTag < Liquid::Tag
def initialize(tag_name, text, tokens)
super
@text = text.strip
@alteist
alteist / everpad_to_zim.sh
Last active March 30, 2016 12:06
This script exports everpad's Evernote client (https://github.com/nvbn/everpad/) database (Schema v5) to zim wiki file sctructure: Evernote/notebook/note -> zim/notebook/note.txt + notebook/note/attachments.ext
#!/bin/bash
### everpad_to_zim.sh v0.1
### Copyleft 2013 by alteist@gmail.com
###
### This script exports everpad's Evernote client (https://github.com/nvbn/everpad/)
### database (Schema v5) to zim wiki file sctructure:
### Evernote/notebook/note -> zim/notebook/note.txt + notebook/note/attachments.ext
###
### THIS SCRIPT DOES NOT:
### * copy attachments in the right place, but in the end of the note instead.
@jbroadway
jbroadway / Slimdown.md
Last active February 5, 2024 10:43
Slimdown - A simple regex-based Markdown parser.
@mastbaum
mastbaum / custom_directive.py
Created May 10, 2012 20:32
Example of a custom ReST directive in Python docutils
'''Example of a custom ReST directive in Python docutils'''
import docutils.core
from docutils.nodes import TextElement, Inline
from docutils.parsers.rst import Directive, directives
from docutils.writers.html4css1 import Writer, HTMLTranslator
class foo(Inline, TextElement):
'''This node class is a no-op -- just a fun way to define some parameters.
There are lots of base classes to choose from in `docutils.nodes`.
@tmtk75
tmtk75 / markdown-tag.rb
Created November 30, 2011 08:10
Jekyll Markdown Tag
=begin
Jekyll tag to include Markdown text from _includes directory preprocessing with Liquid.
Usage:
{% markdown <filename> %}
Dependency:
- kramdown
=end
module Jekyll
class MarkdownTag < Liquid::Tag
def initialize(tag_name, text, tokens)
@indexzero
indexzero / readme-outline.md
Created November 14, 2011 08:26
A quick outline of a README.md

README.md Outline

  • Header and a Brief description (should match package.json)
  • Example (if applicable)
  • Motivation (if applicable)
  • API Documentation: This will likely vary considerably from library to library.
  • Installation
  • Tests
  • Contributors
  • License