Source for the new PnP content
This website is build with Hugo, and is using YAML data files, and markdown as the data storage.
Code in src overrides same file names in themes/portio
- src/config/_default/config.toml
All the contained data of this website is stored in YAML files.
For editing the data of this component, refer to this YAML file: src/data/contents.yml
For the listed plants, systems, and components when navigating the horizontal sub navigation, refer to these files:
- src/data/plants.yml
- src/data/systems.yml
- src/data/components.yml
For modifying the individual guide pages, refer to this files:
- src/content/documents/plants
- src/content/documents/components
- src/content/documents/systems
Follow these step-by-step guide on how to create a new guide page:
- Create a new guide page in
src/content/documents/componentsfor components guide,src/content/documents/plantsfor plants guide, andsrc/content/documents/systemsfor systems guide. - Follow this format for creating the guide page content:
--- title: Sample system 1 type: system author: John Doe layout: single url: "/documents/systems/sample-system-1" --- <Content here in markdown format> - The content of the guide page is in markdown format, but HTML tags can also be used, the website supports rendering HTML tags in the markdown files.
- After the content of the page is done, time to list the guide page to the horizontal sub navigation bar, follow the steps below.
- Go to
src/data/plants.ymlif you want to add a plant page,src/data/systems.ymlfor systems page, andsrc/data/components.ymlfor components page. - Create a new entry under the
documentskey of the YAML file. - It is important to follow the current indentation of the YAML file, and all fields(
document_id,document_type,document_author,document_title, andurl) are required.- NOTE: for the
urlkey, copy the relevant path of the.mdfile that you created earlier.
- NOTE: for the
- Verify if the added entry is displayed in the list of guides in the horizontal sub nagivation bar.
For detailed guide, check this Slite doc. NOTE: This Slite doc covers the creation of new measurement technique, and Calculation methodology pages.
- Navigation Bar - src/layouts/partials/navbar.html
- Footer - src/layouts/partials/footer.html
- src/content/_index.md
- src/layouts/index.html
- images - src/static/images
- stylesheets (SCSS) - src/assets/scss
To get a local copy up and running follow these simple example steps.
- Docker (if you plan on just building and running Hugo through docker)
- You can refer to this site on how to install docker on Linux
git clone [email protected]:cunybpl/nycet_pnp.gitmake build runIf you have issues with permissions, add sudo prior to the command(for Linux OS).
Access the site at http://localhost:1313/
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent