https://github.com/clojure-finance/cim-website
Website of the Center for Investment Management (CIM) at HKU Business School (HKUBS)
https://github.com/clojure-finance/cim-website
investing investment-management stocks trading
Last synced: 7 months ago
JSON representation
Website of the Center for Investment Management (CIM) at HKU Business School (HKUBS)
- Host: GitHub
- URL: https://github.com/clojure-finance/cim-website
- Owner: clojure-finance
- Created: 2024-01-16T06:57:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-10T08:45:09.000Z (7 months ago)
- Last Synced: 2025-03-10T09:43:19.836Z (7 months ago)
- Topics: investing, investment-management, stocks, trading
- Language: HTML
- Homepage: https://cim.hkubs.hku.hk
- Size: 69.4 MB
- Stars: 3
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CIM Website
## Info
This is the website for Center of Investment Management.
## To run/build
```
~$ clojure -X:serve
```
Then access `localhost:3000/Dummy-Website-Test/index.html`
## Importants
After building the webpage, copy the `.htaccess` file under `/public/` to `/public/Dummy-Website-Test/` to disable caching.
## Useful materials
- [Cryogen's Website](https://cryogenweb.org/docs/home.html)
- [Selmer Documentation](https://github.com/yogthos/Selmer)
- [Clojure Cheatsheet](https://clojure.org/api/cheatsheet)
## Documentation of changes (needs update)
The following will be the documentation of changes made/features added based on the `nucleus` theme of cryogen.
1. [Added easier color configuration](#added-easier-color-configuration)
2. [Added theme selection](#added-theme-selection)
3. [Added a way to 'unlink' pages](#added-a-way-to-unlink-pages)
4. [Included LaTeX support](#included-latex-support)
5. [Dates and Authors for pages](#dates-and-authors-for-pages)
6. [Styling](#styling)
7. [Note](#note)
### Added easier color configuration
Instead of changing the color manually in every `css` file, you can now just do all the configurations in `css/dark-theme.css` and `css/light-theme.css`. And here is the list of all parameters:
|Parameters |Description |
|-------------------------|------------------------------------------------|
|`--background` |Background color (`
`) |
|`--main-color` |Primary color |
|`--text-color` |Color of normal text |
|`--hover-color` |Color of text when mouse is hovered over |
|`--menu-background` |Background color of the menu (``)|
|`--footer-text-color` |Color of the footer text |
|`--header-color` |Color of the headers |
|`--blockquote-color` |Color of text in blockquotes |
|`--blockquote-background`|Color of the blockquote background |
|`--table-even-row` |Color of the even rows of the table |
### Added theme selection
Now there is a settings page where you can select between dark and light theme, or you can choose follow system. There can also be other custom themes, by simply including a `-theme.css` file under the `css/` folder. Then you can include a button `` so users can selected the newly added theme.
### Added a way to 'unlink' pages
By default, all pages are unlinked, but if you specify `:link` to be `true` in the page metadata, you can unlink pages, while the linked pages are not affected. It is recommended to set `:page-index` to be negative and `:navbar?` to be `true`. Note linked pages will be displayed first, and unlinked pages will be displayed in the order of `:page-index`, in other words, a page with `:page-index ` set to `-2` will be displayed on top of a page with `:page-index` set to `-1` in the navigation bar.
### Included table customisation
Included `css/table.css` so customizing tables are possible.
### Included LaTeX support
Using `katex` to render LaTeX, simply put the paragraph(s) in the element ``.
**Note**: Due to how cryogen handles superscripts during compilation of markdown files, it will compile any `^` into the `` tags, resulting in the buggy rendering of latex (`$a^b$` becomes `$ab$
`). A workaround is to escape any superscripts, if all the files onl contain latex, run the `latex.py` file first, which converts any `^` in `` into `\^`. If any markdown files needs to be ignored when running `latex.py`, include it in the `EXCLUDE` list. Smarter handling script will be added in the future. Hence, when editing `md` files in vscode, the normal functionality of `\^` will be replaced by `\hatxtd`, and `^` will function the same way as `\^`, see `.vscode/settings.json` for more info.
### More metadata for pages
- Specify the date and author of a page with `:date` and `:last-edited-by` in the metadata for the page. Dates should be in the format of `YYYY-MM-DD`.
- `:navbar-name` to specify the name that will be on the navbar, which can be different to the title
- `:notitle` to disable titles
### Styling
Just look at the CSS files, theres too much to say. Recommended: learn css.
### Note
#### Edits in `src/cryogen/server.clj`
1. As we are still figuring out and learning the clojure language, we used python files to preprocess [latex](#included-latex-support) in markdown files and generate the javascript dealing with theme-selection for now. These files can be seen in `preprocessin-scripts/`, and is ran in the `cryogen.server/preprocess` function (see `src/cryogen/server.clj`).
2. To deal with the rendering of dates in pages, a filter is added in `src/cryogen/server.clj`, called `parseDate`, which parses a string with the format `YYYY-MM-DD` to a `java.util.Date` object, which then can be fed to the [`date` filter](https://github.com/yogthos/Selmer?tab=readme-ov-file#date).
#### Beyond Capabilities of Markdown (Life Hack!)
You can go beyond capabilities of markdown by including **raw** html in the markdown, like
```html
```
in the markdown file to render the video