Git Product home page Git Product logo

xournalpp.github.io's Introduction

Xournal++ Website

This is the repository for the Xournal++ website. A push to the site branch will automatically cause the website to be deployed to master branch.

The website is generated by MkDocs. If you would like to help revise the website, feel free to submit a pull request!

How to contribute

If you want to edit a single page individually, just navigate to the page on GitHub and click the edit button; this will allow you to submit a pull request (PR). Once you've submitted a PR, a maintainer will look over it and then merge it after reviewing it and giving some feedback.

Setting up local web server

If you're editing multiple pages, it might be more useful to preview the site locally. To do so, follow the steps below:

  1. Clone this repository and navigate inside.
  2. If you haven't create a virtualenv, do so by running: python3 -m venv venv
  3. Activate the virtualenv: source venv/bin/activate
  4. If you just created the virtualenv, install the dependencies: pip install -r requirements.txt
  5. Run mkdocs serve to start up a webserver that hosts your local version of the website, which you can access from https://localhost:8080

While developing the website, you may want to refer to the documentation of the dependencies we use:

xournalpp.github.io's People

Contributors

rolandlo avatar technius avatar fatih20 avatar littlehuba avatar langfingaz avatar idotobi avatar arjun-krishna1 avatar dioprz avatar willnilges avatar rubulhoquechoudhury avatar pktiuk avatar mazurel avatar atticus-sullivan avatar jakubkaczor avatar fabian-thomas avatar dieln avatar daholzfeind avatar

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.