Skip to content

Commit

Permalink
README
Browse files Browse the repository at this point in the history
  • Loading branch information
vincentczhou committed Oct 17, 2023
1 parent 04ba603 commit 73de4af
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,35 @@

![SpatialBio Demo](/assets/images/general/README_Banner.png)

```
bundle exec jekyll serve --port 6998 --host 0.0.0.0 --livereload --livereload-port 6997 --force_polling --watch
People's pictures...
```

## Updating
1. Configure ``title`` and ``description`` in ``_config.yml``
2. Backup ``index.md`` to ``/_posts`` and rename accordingly
3. Update the contents of ``index.md``, ``/assets/images/sponsors``

1. Configure `title` and `description` in `_config.yml`
2. Backup `index.md` to `/_posts` and rename accordingly
3. Update the contents of `index.md`, `/assets/images/sponsors`
4. For further customizations, see [Files Modified](#files-modified)

## Files Modified

- [/_includes/head/custom.html](_includes/head/custom.html) - Stylesheet Headers (Bootstrap, etc.)
- [/_includes/head/favicon.html](_includes/head/favicon.html) - Favicon Customization (assets)
- [/_includes/svg/logo.svg](_includes/svg/logo.svg) - Logo Customization (assets)
- [/_includes/footer.html](_includes/footer.html) - Footer Styling
- [/_layouts/sblanding.html](_layouts/sblanding.html) - SpatialBio Layout
- [/_layouts/sbpage.html](_layouts/sbpage.html) - SpatialBio Layout
- [/_posts](_posts) - SpatialBio Archive
- [/_sass/common/components/_modal.scss](_sass/common/components/_modal.scss) - TeXT modal.scss; Commented out to avoid conflicts with Bootstrap
- [/_sass/custom.scss](_sass/custom.scss) - Custom SCSS File
- [/\_includes/head/custom.html](_includes/head/custom.html) - Stylesheet Headers (Bootstrap, etc.)
- [/\_includes/head/favicon.html](_includes/head/favicon.html) - Favicon Customization (assets)
- [/\_includes/svg/logo.svg](_includes/svg/logo.svg) - Logo Customization (assets)
- [/\_includes/footer.html](_includes/footer.html) - Footer Styling
- [/\_layouts/sblanding.html](_layouts/sblanding.html) - SpatialBio Layout
- [/\_layouts/sbpage.html](_layouts/sbpage.html) - SpatialBio Layout
- [/\_posts](_posts) - SpatialBio Archive
- [/\_sass/common/components/\_modal.scss](_sass/common/components/_modal.scss) - TeXT modal.scss; Commented out to avoid conflicts with Bootstrap
- [/\_sass/custom.scss](_sass/custom.scss) - Custom SCSS File
- [/assets](assets) - Asset Customization
- [/_config.yml](_config.yml) - Configuration File
- [/\_config.yml](_config.yml) - Configuration File
- [/about.md](about.md) - About Page
- [/index.md](index.md) - Current SpatialBio Page

#### Notes

- Liquid isn't executable in frontmatter
- Some links may be broken dependending on base url (can be fixed with absolute paths or configuring base url in [/_config.yml](_config.yml))
- Favicon needs to be sized to specification in order to show up properly on Google
- Some links may be broken dependending on base url (can be fixed with absolute paths or configuring base url in [/\_config.yml](_config.yml))
- Favicon needs to be sized to specification in order to show up properly on Google

```
bundle exec jekyll serve --port [PORT] --host 0.0.0.0 --livereload --livereload-port [LIVE_PORT] --force_polling --watch
```

0 comments on commit 73de4af

Please sign in to comment.