mirror of
https://github.com/Textualize/textual.git
synced 2025-10-17 02:38:12 +03:00
5ef98aac90
* Initial layout guide stuff * More docs on layout - grid * Continuing grid docs * Grid gutter and spans guide * Improvements to layout docs for horizontal, vertical, dock, and begin describing layers * Update center layout example to reflect new yield order * More updates to layout guide, mostly offset stuff * More layout guide, "Putting it all together" * Updates to layout guide page * Small rewording of dock layout in guide * Apostrophe * Typo * Small design tweak to combining layouts example * Typos, tidying up * Small reword * Some updates to docs/guide/layout/grid * calc fix Co-authored-by: Will McGugan <willmcgugan@gmail.com>
Documentation Workflow
- Ensure you're inside a Python 3.10+ virtual environment
- Run the live-reload server using
mkdocs servefrom the project root - Create new pages by adding new directories and Markdown files inside
docs/*
Commands
mkdocs serve- Start the live-reloading docs server.mkdocs build- Build the documentation site.mkdocs -h- Print help message and exit.
Project layout
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.