{"id":22377293,"url":"https://github.com/csbiology/csblog","last_synced_at":"2025-04-13T00:23:54.386Z","repository":{"id":32550188,"uuid":"98907320","full_name":"CSBiology/CSBlog","owner":"CSBiology","description":"The blog about all things CSB","archived":false,"fork":false,"pushed_at":"2023-10-20T11:12:28.000Z","size":35200,"stargazers_count":10,"open_issues_count":3,"forks_count":10,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-03-26T18:21:20.433Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://csbiology.github.io/CSBlog/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CSBiology.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2017-07-31T16:05:18.000Z","updated_at":"2023-07-07T14:13:59.000Z","dependencies_parsed_at":"2023-01-14T21:45:26.256Z","dependency_job_id":"68523462-0d57-4c72-ac22-989dd69139d8","html_url":"https://github.com/CSBiology/CSBlog","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CSBiology%2FCSBlog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CSBiology%2FCSBlog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CSBiology%2FCSBlog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CSBiology%2FCSBlog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CSBiology","download_url":"https://codeload.github.com/CSBiology/CSBlog/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248648884,"owners_count":21139372,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-04T22:13:31.498Z","updated_at":"2025-04-13T00:23:54.361Z","avatar_url":"https://github.com/CSBiology.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CSBlog v3\n\nThe csb blog\n\n## Build the blog\n\n### Prerequisites\n\n- [.NET 6.0 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/6.0)\n- Any conda distribution (e.g. [anaconda](https://www.anaconda.com/) or [miniconda](https://docs.conda.io/en/latest/miniconda.html))\n\n- `dotnet tool restore` to install the `fornax` tool that is used to build the website\n- `conda create --name csblog --file requirements.txt` to set up the conda environment\n\n### develop locally in watch mode\n\n- `conda activate csblog` (this has to be done once for each development session)\n- go into the `/src` folder: `cd src`\n- `dotnet fornax watch` to start the site generator in watch mode\n- go to `127.0.0.1:8080` to see the blog\n\n\n## add content\n\nposts are generated from the contents of folders in `/src/posts`.\n\nTo add a new post:\n- add a **folder with the name of your post** to `/src/posts`\n- create a `post_config.md` file. this file should *only* create metadata about your post, and must have this structure:\n    ```\n    ---\n    title: \u003cyour post title\u003e\n    author: \u003cyour name\u003e\n    author_link: \u003ca link\u003e\n    category: \u003cpost category\u003e\n    date: \u003cYYYY-MM-DD\u003e\n    summary: \u003cone-sentence summary of your post\u003e\n    preview_image: \u003cimages/your_image.png\u003e\n    ---\n    ```\n    - `title` is the title of your post\n    - `author` is the author of the post (most likely your name)\n    - `author_link` is a link that will be associated with your name. You can for example link your github or twitter account here\n    - `category` is one of `progress`, `studynote`, `advanced`\n    - `date` is the date of submission in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)\n    - `summary` **OPTIONAL**. A one-sentence summary of your post. think about it as the hook for readers to click on it.\n    - `preview_image` **OPTIONAL**. A link to an image that will be put on top of the post preview. Please use a small, 3 by 1 image for this. \n    \n- create a `post.ipynb` file that contains your blogpost. This notebook will be parsed and rendered to a html site. **do not forget to save the notebook with cell output**, as the notebook will not be executed on site generation.\n\n### `post_config` Dos and Don'ts\n\n- **Don't** use unguarded `:` characters, as they are used to separate keys and values\n    ```\n    title: Yes: No \u003c- nope\n    ```\n- **Do** guard sentences in `\"` quotation marks. That way, you can even use `:` in your post titles and summaries\n    ```\n    title: \"Yes: No\" \u003c- yes\n    ```\n    \n### `post.ipynb` Dos and Don'ts\n\n- **Do** save notebook cell output. Notebooks are **not** run on site generation\n\n- **Don't** put tables of content into your notebooks. TOC are generated on site generation for each post\n\n- **Don't** use headers (any level of `#`) in markdown to emphasize text - it will be put into the table of contents and you might not want that if you only want to put emphasis. use `**` for that.\n\n## Troubleshooting\n\n```powershell\nPS C:\\Repos\\CSBiology\\CSBlog\u003e dotnet fornax watch\nCouldn't find config.fsx\nGenerated site with errors. Waiting for changes...\n[11:16:57] Watch mode started. Press any key to exit.\n[11:16:57 INF] Smooth! Suave listener started in 21.195ms with binding 127.0.0.1:8080\n```\n\nYou are probably not in the ./src folder.\n\n```powershell\n.\n.\n.\nstarting jupyter --output-dir='C:\\Users\\\u003cuser\u003e\\AppData\\Local\\Temp\\' nbconvert --to html C:\\Repos\\CSBiology\\CSBlog\\src\\posts/implementation/consoleTools.ipynb\nEX: An error occurred trying to start process 'jupyter' with working directory 'C:\\Repos\\CSBiology\\CSBlog\\src'. The system cannot find the file specified.\nmake sure to set up a conda distribution with nbconvert installed.\n.\n.\n.\n```\n(and your page is rather empty)\n\nYou probably either have conda and/or nbconvert not installed  \n➡ install it\n\n-or- you don't have it accessible via PATH  \n➡ add it to path -or-  \n➡ use Anaconda Prompt instead\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsbiology%2Fcsblog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcsbiology%2Fcsblog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsbiology%2Fcsblog/lists"}