Skip to content

Commit

Permalink
docs: Declare planned spec
Browse files Browse the repository at this point in the history
  • Loading branch information
attakei committed Oct 12, 2024
1 parent 0590de3 commit b6b9174
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,17 @@
atsphinx-reveal-og-image
========================

Generate og:image content using Reveal.js
Generate ``og:image`` content using Reveal.js

Overview
========

This is Sphinx-extension to generate image contents for ``og:image``.

Images are generated from title of documents and project name
using Reveal.js presentation with Playwright.

.. note:: Installation size is large although only purpose of generating images.

Getting started
===============
Expand All @@ -17,3 +27,7 @@ Getting started
..., # Your extensions
"atsphinx.reveal_og_image",
]
.. This is plan.
When you build document, this generates images into ``BUILD_DIR/_images/og-image/{document-name}.png``

0 comments on commit b6b9174

Please sign in to comment.