1
0
mirror of https://codeberg.org/fediverse/fep.git synced 2026-08-05 19:55:46 +00:00
Files
fep/scripts/create_site_pages.py
T
Helge e4683fbcda Create a FEP static site (#673)
### Preview version

https://helge.codeberg.page/fep/

click there to judge

### Tasks done

- [x] Add a proper index.md instead of final.md .... needs me to filter the readme.md
- [x] search is broken  --> will resolve itself when all feps are part of it
- [x] Update https://codeberg.org/fediverse/fep/src/branch/main/fep/7d8c/fep-7d8c.md
- [x] The admonition format (according to copilot I can blame this format on Microsoft https://learn.microsoft.com/en-us/contribute/content/markdown-reference#alerts-note-important-tip-warning-caution)

    ```
    >[!NOTE]
    >ActivityPub [requires][ActivityPub-Collections] ordered collections to be presented in reverse chronological order. However, an [erratum][ActivityPub-Errata] was proposed to relax this requirement.
    ```
    is not the one supported by python, see https://python-markdown.github.io/extensions/admonition/ . One can probably resolve this by adapting the code https://github.com/Python-Markdown/markdown/blob/f39cf84a24124526c1a0efbe52219fa9950774f6/markdown/extensions/admonition.py

- [x] FEPs miss meta information ....
- [x] Meta information for tracking issue and discussion to link should be formatted
- [x] copy script has problems with contained directories
- [x] add codeberg link to meta, e.g. https://helge.codeberg.page/fep/fep/1b12/
- [x] include implementation counts -> https://codeberg.org/fediverse/fep/issues/686

Co-authored-by: silverpill <silverpill@firemail.cc>
Reviewed-on: https://codeberg.org/fediverse/fep/pulls/673
Reviewed-by: silverpill <silverpill@noreply.codeberg.org>
Co-authored-by: Helge <helge.krueger@gmail.com>
Co-committed-by: Helge <helge.krueger@gmail.com>
2025-11-01 08:40:20 +01:00

43 lines
863 B
Python
Executable File

#!/usr/bin/env python
from fep_tools import index
from fep_tools.site_fep_page import make_page_for_fep
from fep_tools.site_overview_page import write_overview_file
from fep_tools import Readme
path_prefix = "scripts/docs"
with open(f"{path_prefix}/index.md", "w") as fp:
fp.write("""---
hide:
- navigation
---
# Fediverse Enhancement Proposals
<div class="grid cards" markdown>
- [:material-file-document: Final Proposals](./final.md)
- [:material-file-document-edit: Draft Proposals](./draft.md)
</div>
""")
fp.writelines(Readme(include_fep_table=False).content)
for file, status in [
("index.html", "FINAL"),
("draft.html", "DRAFT"),
("withdrawn.html", "WITHDRAWN"),
]:
filename = f"{path_prefix}/{status.lower()}.md"
write_overview_file(filename, status)
for fep in index():
make_page_for_fep(fep)