https://github.com/mosra/magnum-website

Website for the Magnum C++11 graphics engine
https://github.com/mosra/magnum-website

doxygen html5 m-css magnum pelican python restructuredtext webdesign

Last synced: 2 months ago
JSON representation

Website for the Magnum C++11 graphics engine

• Host: GitHub
• URL: https://github.com/mosra/magnum-website
• Owner: mosra
• Created: 2017-06-18T12:10:40.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2025-04-12T14:19:44.000Z (2 months ago)
• Last Synced: 2025-04-12T15:27:44.563Z (2 months ago)
• Topics: doxygen, html5, m-css, magnum, pelican, python, restructuredtext, webdesign
• Language: C++
• Homepage: http://magnum.graphics/
• Size: 80.1 MB
• Stars: 16
• Watchers: 3
• Forks: 12
• Open Issues: 5
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

        
Magnum website

##############

Content for https://magnum.graphics/.

`Setting up a local copy`_

==========================

In order to set up a local copy (for example

`for writing a guest post `_),

you need Python 3 with `Pelican `_,

`Pyphen `_ and `Pillow `_

packages installed and *optionally* some LaTeX distribution for math rendering.

On ArchLinux it's the following packages:

.. code:: sh

    sudo pacman -S texlive-most pelican python-pillow python-matplotlib

    cower -d python-pyphen # Build the python-pyphen package from AUR

On Ubuntu you need these:

.. code:: sh

    sudo apt install texlive-base texlive-latex-extra texlive-fonts-extra python3-matplotlib graphviz

    pip3 install pelican Pyphen Pillow

On Windows and macOS pick some LaTeX distribution and make it available in the

``PATH``. Python packages can be installed via ``pip3`` as well:

.. code:: sh

    pip3 install pelican Pyphen Pillow matplotlib

**Note:** Setting up LaTeX might be problematic and so the website doesn't

strictly require it to make life easier for you --- if LaTeX is not found, it

will render math formulas as unformatted code instead.

Next, make sure to clone the repository (or your fork of the repository)

including submodules so `m.css `_ is properly included

(use :sh:`git clone --recursive`, for example).

That's it. Now you can build the website and start a webserver on

``http://localhost:8000`` with the following command. The website is

automatically rebuilt on changes in the input files.

.. code:: sh

    cd magnum-website

    pelican -Dlr

**Note:** If you are on Windows and you don't have Git symlinks enabled, you

either need to reinstall Git with symlinks enabled (there's a checkbox for that

in the installation wizard) or copy ``m.css/css/*.css`` to ``output/inc/*``,

otherwise the built website will lack all styling. Sorry for the inconvenience.

If you run into problems, please open an issue. The `m.css `_

documentation might also help. Thank you.

Pelican workarounds and publishing notes

========================================

.. todo: htacces

.. todo: doc/index.html