文件列表:

.all-contributorsrc (3806, 2023-12-21)
.eleventy.js (1916, 2023-12-21)
.eleventyignore (18, 2023-12-21)
.eslintrc.js (380, 2023-12-21)
.nvmrc (8, 2023-12-21)
LICENSE (1083, 2023-12-21)
build-scripts/ (0, 2023-12-21)
build-scripts/buildprocess.sh (1305, 2023-12-21)
build-scripts/grundsicherung.yml (282, 2023-12-21)
netlify.toml (500, 2023-12-21)
package-lock.json (333370, 2023-12-21)
package.json (1726, 2023-12-21)
postcss.config.js (180, 2023-12-21)
renovate.json (40, 2023-12-21)
source/ (0, 2023-12-21)
source/404.html (426, 2023-12-21)
source/_data/ (0, 2023-12-21)
source/_data/config.json (201, 2023-12-21)
source/_data/deprecated_processed_kerndatensaetze.csv (22507, 2023-12-21)
source/_data/deprecated_ressourcen_odis.yml (8495, 2023-12-21)
source/_data/deprectaed_ressourcen_extern.yml (2162, 2023-12-21)
source/_data/processed_kerndatensaetze.json (26847, 2023-12-21)
source/_data/ressourcen_extern.json (2563, 2023-12-21)
source/_data/ressourcen_odis.json (10257, 2023-12-21)
source/_includes/ (0, 2023-12-21)
source/_includes/chart_statistik.html (8848, 2023-12-21)
source/_includes/footer.html (60688, 2023-12-21)
source/_includes/gdk-plot.html (12622, 2023-12-21)
source/_includes/graph.html (2770224, 2023-12-21)
source/_includes/head.html (503, 2023-12-21)
source/_includes/js.html (478, 2023-12-21)
source/_includes/logo.svg (11874, 2023-12-21)
source/_includes/macro-image-section-small-shadow.html (282, 2023-12-21)
... ...

 # ODIS Website Repository for the website of Berlins Open Data Informationsstelle (ODIS). ## Setup This site is build with eleventy. Make sure Node.js >+ 14 is installed on your system. Best way to do this is using [nvm](https://github.com/nvm-sh/nvm). ### Installation of Node.js, npm and Eleventy dependencies (once) You can use [nvm](https://github.com/nvm-sh/nvm) to install different Node.js versions. ```bash curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash # Reload your shell session exec $SHELL ``` After that you can install the needed Node.js version. ```bash # move into the repo cd path/to/ods-website # update your local version to the latest state git pull origin master # intall the used Node.js version using nvm nvm install ``` When everything went smoothly you can go ahead and install eleventy's dependencies. ```bash # move into the repo cd path/to/ods-website # install eleventy's dependencies npm ci ``` ## Command Line Usage Install dependencies ```bash npm ci ``` Just writing posts (without working on js or css): ```bash npm start ``` Development: ```bash npm run dev ``` Building site: ```bash npm run build ``` ## Content All page source data is stores in `/sources`folder. The posts for the sections `Aktuelles` and `Veranstaltungen` are stored as posts in the folders `aktuelles` and `veranstaltung` and filtered via the `tags` variable in front matter (Veranstaltungen is tag `event` and Aktuelles is tag `post`). All pages for the projects section are stored in the folder `/source/projekte` and need the tag `project`. Posts and pages need to have to flag `visible: true` to be rendered on the page. The links in the section `Ressourcen` are stored as a json data file in the folder `/source/_data`. ### Adding posts for "Aktuelles" All posts for section "Aktuelles" should be stored in `/aktuelles`. To add a new post simple create a new markdown file (`.md`) in this folder. Specify the site `title`, `metaDescription` and `tags` in the front matter section. The `tags` needs to be set to `post`. ``` --- layout: default.liquid layout: post title: "Testpost" metaDescription: Lorem ipsum... visible: true/false --- # Headline Lorem ipsum.... ``` ### Adding posts for "Veranstaltungen" All posts for section "Veranstaltungen" should be stored in `/veranstaltungen`. To add a new post simple create a new markdown file (`.md`) in this folder. Specify the site `title`, `metaDescription` and `tags` in the front matter section. The `tags` needs to be set to `event`. In adition to that we can add also need to specify a short `description` that will be shown in the "Veranstaltungen" overview page. The fields `time`, `web`, `mail` and `adresse` are optional and appear in the summary section of the page. ``` --- layout: event tags: event title: "Testveranstaltung 2019" metaDescription: Lorem ipsum... description: Lorem ipsum dolor sit amet... visible: true/false time: 12:15 Uhr web: https://example.de mail: info@event.com adresse: Platz der Luftbrücke 4, Gebude H2rund, 12101 Berlin --- # Headline Lorem ipsum.... ``` ### Adding posts for "Projekte" All pages for section "Projekte" should be stored in `/source/projekte`. To add a new project simple create a new folder with a index.md markdown file (`.md`) in it. Specify the site `title`, `metaDescription` in the front matter section. In adition to that we also need to specify a `indexImage` and `heroImage` and set the `tags` to `post`. ``` --- layout: project tags: project title: Kita-Suche in Berlin metaDescription: Lorem ipsum... date: 2019-12-24 visible: true/false indexImage: placeholder.png headerImage: placeholderHeader.jpg --- # Headline Lorem ipsum.... ``` ### Adding an ODIS project to the ODIS website "Projekte" It needs several steps to add an ODIS project to the ODIS website. 1. First of all: the project which needs to be added should be approved and stored within a very own GitHub repository. 2. Second: A new project specific yml-file needs to be created and added to folder **/build-scripts** 3. Shell script named **buildprocess.sh** needs to be updated #### General: How the build process works !Hint: This is currently deprecated for the "grundsicherung" project. You still can use the buildscript.sh script but it wont be run during a normal build. The _netlify.toml_ file manages the build process. ```toml publish = "_site" ``` indicates which folder will be published. ```toml command = "./build-scripts/buildprocess.sh && npm ci && npm run build" ``` runs the Shell script _buildprocess.sh_ and starts the eleventy build process once the shell script was executed. #### Step 1: Get approval and push approved project to master The ODIS project which has to be integrated into the ODIS website should definitely be approved first as the integration process might take a fex minutes (it's not worth the effort, obviously ;)) Once approved, make sure that the master of the GitHub is up-to-date. #### Step 2: Add another yml-file Insode the ODIS website GitHub repo: create another yml-file within the folder named **build-scripts**. The structures of the .yml-file stays the same like in _grundsicherung.yml_, content of file of need to be changed individually. Please find comments in yaml-file below and follow. ```yaml --- tags: project title: "Grundsicherung" #add individual project name blogLinkTitle: "Hier geht's zu den HG Infos" #blogLink: /aktuelles metaDescription: Darstellung der Sozialstatistikdaten zu Grundsicherung. date: 2019-12-17 visible: true #don't change indexImage: ./img/gs-thumbnail.png #add thumbnail for "Projekte" site heroImage: ./img/gs-hero.png --- ``` #### 3. What the buildprocess.sh does & how to update the file 1. It builds a temporary folder "tmp" and clones the whole GitHub Repository of the website which should be integrated (e.g. grundsicherung) as a copy into the tmp folder. 2. moves into freshly copied project folder (e.g grundischerung )and installs node modules 3. ```sh mkdir -p "../../source/projekte/${TARGET}" ``` Runs build inside of the project folder and copies this build folder to the ODIS website folder "source/projekte/" 4. ```sh cat "source/projekte/${TARGET}/index.html" > tmp/tmp_index.html cat "source/projekte/${TARGET}/index.html" > tmp/tmp_index.html ``` Copies index.html content of project to an tmp_index.html within the tmp folder (which was created in the first step). **Important:** Copy of project must be a "tmp" index file to stick to the correct order of the final index.html 5. frontmatter .yml file is added to the final index.html **Important:** the project specific yaml file needs to be created before the Shell script is executed. It will be stored within the same folder like the Shell script 6. Now, all the code of the project website _tmp_index.html_ will be copied to the final index.html within tmp folder --> now index.html has the right order 7. ```shell cp tmp/index.html "source/projekte/${TARGET}/index.html" ``` Copies final index.html to "Projekte" of ODIS website 8. remove tmp folder To update the file almost each step has to be updated. **First:** declare new TARGET (e.g TARGET2) (additonally to existing one) **Second:** clone the ODIS project repository which should b integrated into ODIS website into another tmp folder (e.g. tmp2) **Third:** execute all the following commandd for the second TARGET, therefore use the second tmp folder ### Editing Content When writing simple markdown all the text will be - in one single column - images will have no caption - images will span the column If you want a specialized layout you can use the macros included in `source/_includes` - macro-image-section-small.html - macro-image-section.html ```html {% include "macro-image-section.html", src:"cat.png" caption:"Here is a picture of a cat" %} ``` Hint: include file names need to be quoted. --- Below is a table of all the parameters you can give to them. | name | parm1 | parm2 | parm3 | param4 | | :----------------------------- | :---- | :------ | :---- | :----- | | macro-image-section.html | src | caption | -- | -- | | macro-image-section-small.html | src | caption | -- | -- | #### HTML in [M] You can mix **[M]** with HTML, just make sure you don't mix block level markup. E.g. This wont work! ```html Dies ist ein Typoblindtext. ``` This will work: ```html Dies ist ein Typoblindtext. ``` Or you use html and you can use {% renderTemplate %} and {% renderFile %} tags: https://11ty.dev/docs/plugins/render ```plain {% renderTemplate "md" %} # I am a title * I am a list * I am a list {% endrenderTemplate %} ``` ## Contributors Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

Lisa-Stubert	Fabian Morón Zirfas	Ester	Ralph Schulz	Tori Boeck	Julia Zet	Max B. Eckert
KlemensM	AlexandraKapp	evelynebrie	Tino Desjardins	Dennis Ostendorf	Benjamin Seibel	Lucas Vogel

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! ## Credits

Together with:

A project by:

Supported by:

近期下载者：

相关文件：

评论：[我要评论] [举报此文件]

收藏者：