docs

package
v0.2.0-alpha Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 15, 2024 License: MIT Imports: 3 Imported by: 0

README

Icecake Framework Documentation

The Icecake Framework documentation is composed of a website available at https://icecake.dev and a full go package documentation available at https://pkg.go.dev/github.com/icecake-framework/icecake. This go package documentation is automatically generated when the package is published.

The published website is generated within the /docs directory and served by github pages. Sources of this website are in /website/docs directory.

Go doc comments are written directly at package level within the /pkg and /internal directories.

Rebuild the doc website

Run the command task -t ./build/Taskfile.yaml makedocwebsite to rebuild all the wasm files and the full /website/docs.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DocFooter

func DocFooter(pg *ick.Page) *docFooter

func DocNavbar

func DocNavbar(pg *ick.Page) *ick.ICKNavbar

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL