Skip to content

citation-file-format/cff-initializer-javascript-v1

Repository files navigation

  • DOI
  • FOSSA Status
  • Build Status
  • Markdown links

Web form to initialize CITATION.cff files


Note: we're working on a new version of the cffinit website here.



Live version

Documentation for users

  • Check out the live version here.
  • For the rationale behind CITATION.cff files, read the blog.
  • For the Citation File Format specification, go here (latest) or here (stable).
  • For the Citation File Format home page, go here.

Documentation for developers

Build Setup

# install dependencies
npm install

# serve with hot reload at localhost:8080
npm run dev

# build for production (with disabled minification)
npm run build

# npm run build and update the local copy of the gh-pages content in docs/
npm run ghpages

# run eslint on the *.js and *.vue files under src/
npm run lint

For detailed explanation on how things work, consult the docs for vue-loader.

linting

The rules are in .eslintrc, the setup is described here: https://alligator.io/vuejs/vue-eslint-plugin/

Project was bootstrapped with https://github.com/vuejs-templates/webpack-simple

Markdown link checker

If you want to check if the links in your markdown work, run markdown-link-check

find . -name '*.md' -not -path './node_modules/*' -exec \
markdown-link-check '{}' --config .mlc-config.json ';'

License

FOSSA Status