Skip to content

A section in readme on how to add author information. #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dimazest wants to merge 1 commit into
base: theme
Choose a base branch
from
Open

A section in readme on how to add author information. #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,29 @@ Commit and push our changes::

Create a `pull request <https://help.github.com/articles/creating-a-pull-request>`_.

Add information about yourself
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can add information about yourself, such as a brief description of who you
are, your interests, your homepage and contact information, and, most
importantly, a picture.

Author bibliographies are stored in ``content/authors``. Here is an example of
``dmitrijs-milajevs.rst``:

.. code-block:: rst

:slug: dmitrijs-milajevs
:cover_image: static/author_images/dmilajevs.jpg
:homepage: http://www.eecs.qmul.ac.uk/~dm303/

`Dima`__ is a Ph.D. student at Queen Mary.

__ http://www.eecs.qmul.ac.uk/~dm303/

The cover image is a 461x461 picture of you or an avatar and should be located
in `content/static/author_images`.

Why should I bother?
--------------------

Expand Down