Git Product home page Git Product logo

igem-wiki-starter's Introduction

iGEM Wiki Starter Pack

The iGEM Wiki Starter Pack is the easiest way to create your iGEM Wiki.

Documentation Status License: MIT

This starter pack contains everything you need to build your wiki, and then some. It comes with a great design out of the box, so you can write your wiki in plain English (well, almost - it's Markdown) and it look good on each device.

It also makes it really easy for you to customize the design, while still making it possible for everyone in your team to write content in Markdown. Along with common web development libraries like Bootstrap, jQuery, MathJax and Font Awesome, it also includes small utilities that automate tasks like adding citations to your wiki. It automatically pulls title, author and publisher information from an article's DOI and includes them at the end of the page.

It also comes with our Python package, WikiSync, built in, which uploads your entire wiki at once. WikiSync integrates effortlessly into automation workflows like Github Actions and Travis CI so everytime a team member adds content to your wiki repository on Github, it gets automatically uploaded to iGEM.org.

The starter pack makes building your wiki as easy as writing plain English and uploading, as simple as a git push.

Please head over to the documentation for installation instructions and a usage guide to get started.

Note: These docs are currently under development and some sections are incomplete or missing. We're working to put them up as fast as we can, and we'll have a complete draft up here soon.

Meanwhile, you can take a look at the documentation we use within our team at https://github.com/igembitsgoa/wiki/wiki. It has almost everything about using the included theme and more information about customization will be put up here soon.

Features

  1. Built-in theme that
    • Looks great on all devices
    • Comes with a dark mode
  2. Markdown support
  3. Automatic uploads with WikiSync
  4. Extract citation information from DOI
  5. Automatic table of contents on each page
  6. Easy popup definitions
  7. Endless customization with Webpack
  8. Included common web development libraries
    • Bootstrap
    • jQuery
    • MathJax
    • Font Awesome
  9. Extensive templating using Pug
  10. Reset styles on iGEM.org

Contribution and Collaboration

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Please visit our Contributing page to find out how you can help make this project better.

Using this software or submitting issues and pull requests can count towards a collaboration for our teams. Please give us a shoutout at @igem_bits on Instagram if this Starter Pack has made your iGEM experience easier! For contibuting to this software or discussing further collaborations, please reach out to us at [email protected].

igem-wiki-starter's People

Contributors

ballaneypranav avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

igem-wiki-starter's Issues

Can't install igem-wiki-starter

I am not able to install the igem-wiki-starter . This is the error I am getting while install requirements file -

error: cargo failed with code: 101

Failed building wheel for cryptography
Running setup.py clean for cryptography
Failed to build cryptography
Could not build wheels for cryptography which use PEP 517 and cannot be installed directly

Any solution?

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.