Skip to main content

build_site

abbaye::site

Function build_site 

Source 
pub async fn build_site(config: AbbayeConfig) -> Result<()>
Expand description

Build the full website into config.output_dir (defaults to public/).

ยงSteps

  1. Extract the current version via the configured [AnyVersionExtractor].
  2. Run every configured builder and split the resulting [ArtifactPath]s into dist (regular files) and docs (directories).
  3. Copy dist artifacts to <output>/<version>/dist/.
  4. Copy doc directories to <output>/<version>/docs/<crate>/ and archive the whole docs/ tree as docs.tar.gz.
  5. Render <output>/<version>/index.html from the project README and the matching changelog section.
  6. Re-render the root <output>/index.html, listing all known versions (newest first).
  7. Update the <output>/latest symlink (Unix) or redirect page (other).