To use HyloDoc for generating websites, you can use its command line interface or use it as a library in your project to gain more control and customization.
To get started, set up the development environment, cl
8000
one the repository and run
the hdc target:
swift run hdc --help
# Outputs documentation of one module to ./dist
swift run hdc PATH_TO_MODULE
# Process multiple modules
swift run hdc PATH_TO_MODULE_1 PATH_TO_MODULE_2 ...
# Specify output directory
swift run hdc PATH_TO_MODULE --output OUTPUT_DIRECTORY
# open up the generated website in a web server
swift run hdc PATH_TO_MODULE && python3 -m http.server 8080 -d dist
# Generate documentation for the standard library
swift run hdc PATH_TO_STDLIB --documenting-standard-libraryYou can read our syntax specification in the Syntax Reference
- Install the requirements of the Hylo repository
- CLone the repository
- Install docker and WSL2
- Clone the repo into a WSL folder
- Open the repo in Windows VSCode, reopen it in devcontainer
- Install docker on linux
- Clone the repo
- Open the repo in VSCode, repoen it in devcontainer
- After the first successful build, you should be able to debug individual tests cases and test methods by clicking on the green arrow next to them. If you right-click the arrow, you will have the option to debug the particular test.
To run all tests, you can use the following command:
swift testAlternatively, in VSCode after the first full build of the project, you should be able to see green arrows next to the test cases, which you can click to run them individually, and to debug them.
This project uses the swift-format library to enforce good formatting of all .swift files. There is a job in the
pipeline that will fail if the library finds any lines of code that do not conform to the ruleset .swift-format.json.
To check if your staged files adhere to this standard you can run the following command in the devcontainer terminal:
swift-format lint -r --configuration .swift-format.json -p Sources Tests Package.swift
If there are any problems, one can run this command to fix most errors:
swift-format --in-place -r --configuration .swift-format.json -p Sources Tests Package.swift
However, there are some limitations to this command that will still fail the pipeline, which will require manual modifications.
There's a pre-commit git hook that will run the format command on any staged .swift files. It is provided as
pre-commit in the project root.
To use it you have to have Swift 5.9 installed and available in the PATH environment variable. Next, you will have to
install the swift-format library locally and add it to $PATH. Navigate to a suitable location and run the following
command:
git clone -b release/5.9 https://github.com/apple/swift-format.git && cd swift-format && swift build -c release && export PATH="$(pwd)/.build/release:$PATH" && swift-format --version
This will clone and build the required swift-format version and add it to your PATH. If the installation has been
successful, the terminal output should read 509.0.0.
Finally, the pre-commit script should be added to your .git folder. Copy pre-commit from the project root and paste
it in .git/hooks.