Skip to content

Commit

Permalink
Merge pull request #728 from MITLibraries/update-docs
Browse files Browse the repository at this point in the history
Update documentation on building docs locally
  • Loading branch information
JPrevost authored Aug 22, 2023
2 parents 4ca1072 + 41ef445 commit c990772
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,9 @@ to ensure everything looks as expected.
bundle exec jekyll serve --incremental --source ./docs
```

Once the jekyll server is running, you can access the local docs at http://localhost:4000
Once the jekyll server is running, you can access the local docs at http://localhost:4000/timdex/

Note: it is important to load the documentation from the `/timdex/` path locally as that is how it works when built and deployed to GitHub Pages so testing locally the same way will ensure our asset paths will work when deployed.

### Automatic generation of technical specifications from GraphQL

Expand Down

0 comments on commit c990772

Please sign in to comment.