Aller au contenu

Contributing to the Site#

This is a personal site of Oleg Nenashev, but any contributions, typo fixes and patches are welcome. The website engine, tooling and configuration are also open source, feel free to reuse and contribute. If you want to work together and build a template on the top of Material for MkDocs, let me know :)

Quick Start#

For the local development without full rebuild:

mkdocs serve

Full build with PDF generqation:

GENERATE_PDF=true mkdocs build

Under the Hood#

The site is built with MkDocs, MkDocs Multirepo Plugin, and Material for MkDocs. For development, everything is powered by Dev Containers and GitHub Actions.

Talks#

The site contains a Speaking site, which is expected to convert to a separate plugin later. Forks and contributions are welcome!

Talk Metadata#

Use presented for events where a talk was delivered and cancelled for cancelled appearances. Both fields accept a list of events with event, year, month, url, location, and note as applicable.

Set ogImage to an absolute image URL to use a custom Open Graph and Twitter preview image for a talk or workshop. It also appears in the listing and details popup. When both ogImage and speakerdeckId are set, ogImage takes precedence; otherwise the first Speaker Deck slide is used when available.

Set status in a talk or workshop's front matter to control its listing:

  • highlighted displays the item prominently at the top of its section.
  • normal displays it normally and is the default when status is omitted.
  • collapsed places it behind the section's More talks button. Without JavaScript, collapsed items remain visible.
  • hidden excludes it from the listing and tag cloud.

Items in each status are sorted by title. These settings affect the lists only: the individual pages remain published and may appear in site search.

Talk and Workshop Categories#

The lists use the tag-based categories in talk-categories.yml and workshop-categories.yml, respectively. Each item appears in the matching category with the highest match_priority; ties use the order in the YAML file. Unmatched items appear under Other talks or Other workshops. Empty categories are omitted.

Localization#

The default language of the website is English. Some pages are in French. For that, the mkdocs-static-i18n plugin is used on the top of the default Material for MkDocs functionality.

License#

This site by Oleg Nenashev is licensed under CC BY 4.0