Skip to content

L3au/gitbook-plugin-git-author

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gitbook-plugin-git-author

This is a plugin for automatically adding author and timestamp to each gitbook page, including creator and last-modified from git commits

npm travis codecov npm-downloads

git-author-preview

Usage

Recommended Environments

  • Node.js 4.0+
  • npm 3.0+
  • gitbook 3.0+

install

npm i -D gitbook-plugin-git-author

book.json

{ "plugins": ["git-author"] "pluginsConfig": { "git-author":{ "position": "bottom", "modifyTpl": "Last modified by {user} {timeStamp}", "createTpl": "Created by {user} {timeStamp}", "timeStampFormat": "YYYY-MM-DD HH:mm:ss" } } }

Example

README.md file

Be sure to commit this file to git repository firstly.

# Title of the Article content

Output

<h1>Title of the Article</h1> <p>content</p> <div class="git-author-container git-author-bottom"> <div class="modified">Last modified by someone 2016-06-06 06:06:06</div> <div class="created">Created by someone 2016-06-06 06:06:06</div> </div>

Options

position

default: bottom

git-author content position in the article. top or bottom

this will add a git-author-{position} className to git-author-container

createTpl modifyTpl

You can use {user} {timeStamp} as placeholder for username and timeStamp

default:

createTpl: Created by {user} {timeStamp}

modifyTpl: Last modified by {user} {timeStamp}

You may disable one of them by set it to a FALSY value.

e.g

"createTpl": false 

timeStampFormat

default: YYYY-MM-DD HH:mm:ss

use moment to process timeStamp

Useful filters

You can use timeFormat nunjucks filter to format time string in each article.

timeFormat([timeFormatString])

{{ 1466749374153 | timeFormat('YYYY-MM-DD') }} 

output

2016-06-24 
{{ '2016-06-24T07:27:04.365Z' | timeFormat('MMMM Do YYYY, h:mm:ss a') }} 

output

June 24th 2016, 3:27:04 pm 

Custom styles

change default style by add a custom css file to your gitbook

book.json

{ "styles": { "website": "./styles/website.css" } }

website.css

.git-author-container { font-size: 85%; } .git-author-top { float: none; } 

About

A gitbook plugin to show git author info

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •