Giter Club home page Giter Club logo

doc-template's People

Contributors

kcopas avatar mattblissett avatar timrobertson100 avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

doc-template's Issues

Improve this document link/icon/nav item

@MattBlissett what I'd like to do is have a document called 'CONTRIBUTING.en.adoc' in each document's directory and add a link to it in the top of the nav with the label 'Improve this document'. I have two magic wand icons saved in ../img/_src in this repo, one azure blue and one GBIF green. Use whichever works best (wish it was blue, but the consistent use of green might be better).

This is a global change, one I'd like to retrofit into the existing repos we have in development. Hoping that having it be a separate file doesn't make for any unpleasantness. The only place where I need to link to it from the text is in the document guidelines repo.

Key topics for author guidance

Cover the following areas:

Abbreviations/Acronyms
Cross References
Dates and Numbers
Figures, Tables, and Examples
Headings
Links
Lists
Numbered list
Variable list
Bulleted list
Miscellaneous
Punctuation
Typography and Font Conventions
Bibliographical Entries and Footnotes

Code

  • Line Length
  • Syntax Highlighting
  • Formatting Code in Word

See O'Reilly precedent

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.