Skip to content

Commit

Permalink
rename main branch to "main"
Browse files Browse the repository at this point in the history
  • Loading branch information
bast committed Mar 13, 2021
1 parent 27a3402 commit b6aff1c
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 18 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ name: Test

on:
push:
branches: [ master ]
branches: [ main ]
pull_request:
branches: [ master ]
branches: [ main ]

jobs:
build:
Expand Down
16 changes: 8 additions & 8 deletions doc/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ This API is currently the default::

/v3/<engine>/<engine_version>/<repo>/<branch>/<path>

Examples with `files on GitHub <https://github.com/bast/cicero/tree/master/demo>`__:
Examples with `files on GitHub <https://github.com/bast/cicero/tree/main/demo>`__:

- https://cicero.xyz/v3/remark/0.14.0/github.com/bast/cicero/master/demo/remark/simple/talk.md
- https://cicero.xyz/v3/remark/0.14.0/github.com/bast/cicero/master/demo/remark/styling/talk.md
- https://cicero.xyz/v3/remark/0.14.0/github.com/bast/cicero/master/demo/remark/equations/talk.md
- https://cicero.xyz/v3/remark/0.14.0/github.com/bast/cicero/master/demo/remark/original/talk.md
- https://cicero.xyz/v3/remark/0.14.0/github.com/bast/cicero/master/demo/remark/header-footer/talk.md
- https://cicero.xyz/v3/reveal.js/3.7.0/github.com/bast/cicero/master/demo/reveal.js/talk.md
- https://cicero.xyz/v3/remark/0.14.0/github.com/bast/cicero/main/demo/remark/simple/talk.md
- https://cicero.xyz/v3/remark/0.14.0/github.com/bast/cicero/main/demo/remark/styling/talk.md
- https://cicero.xyz/v3/remark/0.14.0/github.com/bast/cicero/main/demo/remark/equations/talk.md
- https://cicero.xyz/v3/remark/0.14.0/github.com/bast/cicero/main/demo/remark/original/talk.md
- https://cicero.xyz/v3/remark/0.14.0/github.com/bast/cicero/main/demo/remark/header-footer/talk.md
- https://cicero.xyz/v3/reveal.js/3.7.0/github.com/bast/cicero/main/demo/reveal.js/talk.md

Examples with `files on GitLab <https://gitlab.com/bast/cicero-example/tree/master/demo>`__:

Expand All @@ -32,7 +32,7 @@ This API is the past but still supported::

/v2/remark/github/<namespace>/<repo>/<branch>/<path>

Example: https://cicero.xyz/v2/remark/github/bast/cicero/master/demo/remark/original/talk.md
Example: https://cicero.xyz/v2/remark/github/bast/cicero/main/demo/remark/original/talk.md


v1
Expand Down
6 changes: 3 additions & 3 deletions doc/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ Let us assume your talk is on (replace ``<namespace>`` and ``<repository>``)::

You can now visit (replace ``<namespace>`` and ``<repository>``)::

https://cicero.xyz/v3/remark/0.14.0/github.com/<namespace>/<repository>/master/mytalk.md
https://cicero.xyz/v3/remark/0.14.0/github.com/<namespace>/<repository>/main/mytalk.md

Of course you can reference another branch or tag or hash than ``master``.
Of course you can reference another branch or tag or hash than ``main``.

If you like https://revealjs.com better, then check https://github.com/bast/cicero/tree/master/demo/reveal.js.
If you like https://revealjs.com better, then check https://github.com/bast/cicero/tree/main/demo/reveal.js.
10 changes: 5 additions & 5 deletions doc/style.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ How to use your own CSS
If you place a file in the same path as your talk, with the same name as your
talk, and only replace the ``.md`` suffix by ``.css``. Then the rendering engine
will use this file:
https://github.com/bast/cicero/blob/master/cicero/templates/render.html#L11-L13
https://github.com/bast/cicero/blob/main/cicero/templates/render.html#L11-L13

In other words, if your talk is called ``mytalk.md`` and you want to customize CSS,
place a file called ``mytalk.css`` in the same place as your ``mytalk.md``.

With this you can even override CSS directives and style your slides to your
heart's content.

Example: https://github.com/bast/cicero/tree/master/demo/remark/styling
Example: https://github.com/bast/cicero/tree/main/demo/remark/styling


Images
Expand Down Expand Up @@ -51,14 +51,14 @@ external JavaScript library?

You can place ``*.head.html`` and/or ``*.body.html`` alongside your ``*.md`` slides.
In these files you can do and change almost everything:
https://github.com/bast/cicero/blob/master/cicero/templates/render.html.
https://github.com/bast/cicero/blob/main/cicero/templates/render.html.

To get inspired of what is in these by default and what can be changed, please
browse https://github.com/bast/cicero/tree/master/cicero/static/engines.
browse https://github.com/bast/cicero/tree/main/cicero/static/engines.


Math equations
==============

Here is an example:
https://github.com/bast/cicero/tree/master/demo/remark/equations
https://github.com/bast/cicero/tree/main/demo/remark/equations

0 comments on commit b6aff1c

Please sign in to comment.