szaghi

szaghi / formal

Public

Generate beautiful API documentation websites for Fortran projects. FORMAL bridges FORD (Fortran Documenter) and VitePress (Vue-powered static site generator)

17
0
100% credibility
Found Feb 17, 2026 at 10 stars -- GitGems finds repos before they trend. Get early access to the next one.
Sign Up Free
AI Analysis
Python
AI Summary

FORMAL generates attractive, searchable documentation websites from documentation comments in Fortran source code.

How It Works

1
📖 Discover FORMAL

You hear about a helpful tool that turns notes in your Fortran code into a beautiful, easy-to-search documentation website for your project.

2
🛠️ Set it up on your computer

You quickly add the tool to your setup so it's ready to use anytime.

3
📁 Prepare your project's docs folder

You run a simple setup command, and it creates all the folders and starting pages tailored to your Fortran project.

4
✨ Create the docs pages

The tool reads the helpful notes right from your code and builds organized pages listing types, procedures, and explanations with pretty math and code highlights.

5
👀 Preview your site

You open a local view and see your professional-looking documentation site come alive, complete with search and navigation.

🎉 Share beautiful docs

Your Fortran project now has a stunning, searchable website that makes it easy for anyone to understand and use your code.

Sign up to see the full architecture

4 more

Sign Up Free

Star Growth

See how this repo grew from 10 to 17 stars Sign Up Free
Repurpose This Repo

Repurpose is a Pro feature

Generate ready-to-use prompts for X threads, LinkedIn posts, blog posts, YouTube scripts, and more -- with full repo context baked in.

Unlock Repurpose
AI-Generated Review

What is formal?

Formal is a Python tool that turns Fortran doc comments into polished API documentation sites. It hooks FORD's parser to extract module details, types, procedures, and math equations, then spits out Markdown ready for VitePress static sites. Developers get searchable pages with auto-sidebars, argument tables, LaTeX rendering, and Fortran syntax highlighting—no manual HTML grinding.

Why is it gaining traction?

Fortran docs have lagged behind modern stacks; formal bridges that with a dead-simple CLI (`formal init` scaffolds a full VitePress setup, `formal generate` builds API pages). It auto-groups modules by source structure, links cross-references, and supports Mermaid diagrams for calls/inheritance—generate beautiful tables and text that look pro out of the box. Unlike clunky FORD HTML or generic Markdown tools, it delivers VitePress's speed and themes tailored for formal methods github or formal verification projects github.

Who should use this?

Fortran library authors in HPC or scientific sims needing clean API refs with math. Teams maintaining portability layers or physics solvers who want GitHub Pages-ready docs without ditching `!<` comments. Skip if you're not in Fortran—it's niche, like formaldehyd geruch for specific smells.

Verdict

Grab it if you're documenting Fortran: solid CLI, tests, and showcases make setup painless despite 10 stars and 1.0% credibility score. Still alpha (v0.2.8), so test on non-critical projects first—docs guide covers deployment to Netlify or Pages.

(198 words)

Sign up to read the full AI review Sign Up Free

Similar repos coming soon.