Skip to content

Commit

Permalink
Repairing broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
wendellpiez committed Mar 29, 2022
1 parent 85cfa20 commit 00bcbca
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/content/contribute/styleguide.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ This page also serves as a demo. Any feature on this page can be seen in action
### Diagrams
For diagrams (not bitmap images such as photos or scans) we much prefer SVG, as clean as you can make it, due to its scalability, adaptability and versatility. You can see an SVG embedded into a page on the site: [Well-formed Data Formats and Valid OSCAL](/concepts/layer/validation/).
For diagrams (not bitmap images such as photos or scans) we much prefer SVG, as clean as you can make it, due to its scalability, adaptability and versatility.
Like any web site, Hugo will also serve JPEG and PNG formats to browsers, but it will not be as easy to align colors and fonts. `alt` tagging is always wanted on any images called in as files, as described under [Images](#images).

Expand Down Expand Up @@ -103,7 +103,9 @@ Keep in mind when editing Markdown files that Markdown, lacking a single externa
#### Running the OSCAL site locally
As described in the [readme documentation for the docs](docs/readme.md) directory, running Hugo with its own server locally is a convenient way of previewing site contributions as they will actually appear. Not all content (especially if unproblematic Markdown) needs to be previewed, but it is a good way to intercept display problems early.
Running Hugo with its own server locally is a convenient way of previewing site contributions as they will actually appear. Not all content (especially if unproblematic Markdown) needs to be previewed, but it is a good way to intercept display problems early.
This is documented in the repository [docs directory readme](https://github.com/usnistgov/OSCAL/tree/main/docs).
From a Linux shell, use command
Expand All @@ -113,7 +115,7 @@ $ hugo server -v --debug --minify

to start the server on port 1313, viewable at `http://localhost:1313/OSCAL/`.

Note that (as detailed in the [docs directory readme](https://github.com/usnistgov/OSCAL/tree/main/docs), to browse the entire site with all contents, including generated contents, additional scripting may need to be run prior to starting the server.
Note that (as detailed in the readme) to browse the entire site with all contents, including generated contents, additional scripting may need to be run prior to starting the server.

## Style

Expand Down

0 comments on commit 00bcbca

Please sign in to comment.