Git Product home page Git Product logo

aiida-website's Introduction

aiida-website

The primary website for AiiDA.

How to add a post

Clone this repository and create a new branch.

Then, either run python create_post.py -h or follow the steps manually:

  1. Create a Markdown file in docs/news/posts, named by the date and keyword.
  2. Add the ablog topmatter to the page
  3. Write in MyST Markdown
  4. If the post announces or reports on an event, then update the docs/events.yaml file.

Finally, create a PR to this repository.

Tips

The top-matter category should be one of the following:

  • News: To announce a general news
  • Events: To announce an event
  • Reports: To report on an event
  • Release: To announce a new release
  • Blog: A blog post

You can use the update directive to note an update to an existing post.

Use the subfigure directive, to arrange multiple images in a figure.

Building the documentation locally

Install and run tox to install a local virtual environment and build the documentation, or directly install requirements.txt and run: sphinx-build -nW --keep-going -b html docs/ docs/_build/html.

To check HTML links, run tox -e linkcheck or sphinx-build -b linkcheck docs/ docs/_build/linkcheck.

TODO

  • Feedback forms (contact us, Join us)
  • Decide on set of post categories/tags
  • Upstream to ablog
    • Empty postlist placeholder
    • image number for topmatter
    • event date
    • fix blog_post_pattern?
    • config for "All Posts"

aiida-website's People

Contributors

chrisjsewell avatar giovannipizzi avatar mbercx avatar pre-commit-ci[bot] avatar ramirezfranciscof avatar sphuber avatar unkcpz 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.