| Commit message (Collapse) | Author | Files |
|---|
|
feat: Allow packages to define custom doc URL and badge
Co-authored-by: Jacob Oaks <jacoboaks.8@gmail.com>
Co-authored-by: r-hang <rhang@uber.com>
|
|
Adds a `-templates` flag that can be used to provide
an alternative directory with templates for Sally to use.
The new templates override the default set embedded in Sally.
This includes a new 404 template so that 404 errors
use the same theme as the rest of the website.
Additionally, for HTTP status >400,
this also sets the Cache-Control header
to discourage CDNs like Cloudflare from caching the page.
Resolves #125, #18
|
|
* Remove branch from PackageConfig struct
With #92, branch is no longer necessary from PackageConfig
struct since go-source tag was removed.
This removes Branch field from PackageConfig.
* update README
|
|
Adds a workflow that builds and publishes a Docker image
to ghcr.io based on the Dockerfile in the root of the repository.
This will become available at
https://github.com/uber-go/sally/pkgs/container/sally.
Users will be able to import it by using `ghcr.io/uber-go/sally:$tag`
with `docker pull` or in the `FROM` clause of their own Docker file.
As a test for this, I published it manually to my own fork.
The image is at https://github.com/abhinav/sally/pkgs/container/sally.
With that, I ran the following Dockerfile:
FROM ghcr.io/abhinav/sally:master
COPY sally.yaml /
And it worked as expected.
|
|
* template: Use a more fluid layout
Instead of using a table, take advantage of the grid layout.
We still print a table of sorts,
but it's more fluid in appearance based on width of the screen.
On narrower screens, we'll show a listing
where each item has a description label next to it
rather than at the top.
* Add support for package descrpitions
Packages may now optionally specify a description.
If specified, this is printed below the package information,
indented one column to make it stand out.
Co-authored-by: Sung Yoon Whang <sungyoonwhang@gmail.com>
|
|
Adds more details on how to configure sally
and what the required and optional fields are.
Also updates the installation instructions
since you can't `go get` the binary anymore.
|
|
Update our default Godoc server from `` to the shiny, new `https://pkg.go.dev/`
See https://github.com/uber-go/sally/issues/39, T4832833
|
|
This adds the ability to change the godoc.org instance used by Sally to
link to documentation by providing a new `godoc` section in the
configuration.
|
|
|
|
|
|
|
|
|
