Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
This is an example package for testing the typedoc-theme-fresh theme. It contains exactly what you'd expect from a demo package:
Calculator class that can add and subtract (multiplication and division were deemed too ambitious)formatCurrency function for when you need to make your numbers look fancyfoo.value (spoiler: it's 42)You don't install this. This is an example. It lives here, in this repo, serving its noble purpose of generating documentation.
import { Calculator, formatCurrency, foo } from "example";
// Perform advanced mathematics
const calc = new Calculator();
const sum = calc.add(2, 2); // 4, allegedly
// Make money look professional
const price = formatCurrency(99.99); // "$99.99"
// Access the meaning of life
console.log(foo.value); // 42
// Learn about beans
console.log(foo.beans.taste); // "delicious"
number + number returning number needs that extra safetyThe generated documentation is the whole point of this package's existence. Run the theme build to see it in action.
This code is so simple it probably can't be copyrighted, but it inherits whatever license the parent project has.
This is an example package. If you're thinking about contributing to it, maybe consider contributing to the actual theme instead? Just a thought.