https://github.com/LeeKaiXuan/PSS_Cookbook

Documentation for introducing the usage of PSS language.
https://github.com/LeeKaiXuan/PSS_Cookbook

Last synced: 2 months ago
JSON representation

Documentation for introducing the usage of PSS language.

• Host: GitHub
• URL: https://github.com/LeeKaiXuan/PSS_Cookbook
• Owner: LeeKaiXuan
• License: apache-2.0
• Created: 2023-09-28T08:42:35.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-03T03:12:49.000Z (about 1 year ago)
• Last Synced: 2024-05-23T10:20:08.287Z (8 months ago)
• Language: Dockerfile
• Homepage: https://leekaixuan.github.io/PSS_Cookbook/
• Size: 872 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-hdl - PSS CookBook - Documentation for introducing the usage of PSS language (PSS : Portable test and Stimulus Standard)

README

        
## PSS_Cookbook

Documentation for introducing the usage of PSS language.

## Setup (Local Builder)

If you need to generate the website locally, please install MkDocs first. (Reference: https://squidfunk.github.io/mkdocs-material/getting-started/)


I recommend using docker if you develop on Microsoft Windows (e.g., win10/win11).

Steps of setup docker:

1. Download and install [Docker Desktop](https://www.docker.com/products/docker-desktop/).

2. In Docker Desktop, search `squidfunk/mkdocs-material` on the top console then pull it.

3. Clone this repo to a local directory.

4. Go to the directory, and create a text file named `Dockerfile` without any extension.

5. Paste the following context into `Dockerfile`:

```Dockerfile

FROM squidfunk/mkdocs-material

RUN pip install mkdocs-macros-plugin

RUN pip install mkdocs-glightbox

RUN pip install mkdocs-git-revision-date-localized-plugin

```

6. Run PowerShell at the current path and enter following command:

```bash

docker build -t squidfunk/mkdocs-material .

```

7. The older docker image can be deleted.

## Previewing on Docker

Run a PowerShell inside the local repo with following command:

```bash

docker run --rm -it -p 8000:8000 -v .:/docs squidfunk/mkdocs-material

```

Once the local MkDocs' server is ready, you can preview it on [```http://localhost:8000/```](http://localhost:8000/).


The server will auto-build the website every time any files under [docs/](docs) are updated.