diff --git a/.gitignore b/.gitignore index 3a62a37c..0f29e2f6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,6 @@ +vendor +.bundle .DS_Store _site +.jekyll-cache +Gemfile.lock diff --git a/Gemfile b/Gemfile new file mode 100644 index 00000000..17fac573 --- /dev/null +++ b/Gemfile @@ -0,0 +1,13 @@ +# frozen_string_literal: true + +source "https://rubygems.org" + +git_source(:github) {|repo_name| "https://github.com/#{repo_name}" } + +# gem "rails" + +gem "jekyll-paginate", "~> 1.1" + +gem "jekyll-redirect-from", "~> 0.16.0" + +gem "webrick", "~> 1.7" diff --git a/README.md b/README.md index 058f187a..f864c063 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,23 @@ node-red.github.io ### Contributing / Fixes For simple typos and single line fixes please just raise an issue pointing out -our mistakes. If you need to raise a pull request please read our -[contribution guidelines](https://github.com/node-red/node-red/blob/master/CONTRIBUTING.md) +our mistakes. For larger changes, please discuss them on the [forum](https://discourse.nodered.org) or [Slack team](http://nodered.org/slack/) #docs channel. + +If you need to raise a pull request please read our +[contribution guidelines](https://github.com/node-red/node-red/blob/main/CONTRIBUTING.md) before doing so. + +### Previewing the Site +This site is a Github Pages site that uses [Jekyll](https://github.com/jekyll/jekyll) for static site generation. To preview and test the site, first, make sure [Jekyll is installed](https://jekyllrb.com/docs/installation/). + +Fork the repository so you can make changes, commit them to your own repository and make pull requests for review. Then clone the repository if you haven't already: + + git clone https://github.com/{your-github}/node-red.github.io + +First time you run jeykll you need to do bundle install 1st for the dependencies, + + cd node-red.github.io + bundle install + bundle exec jekyll serve -w + +Once the site is built and running you can preview it at [`http://127.0.0.1:4000/`](http://127.0.0.1:4000/). diff --git a/_config.yml b/_config.yml index 968ed936..21e8fb6c 100644 --- a/_config.yml +++ b/_config.yml @@ -1,8 +1,14 @@ name: Node-RED markdown: kramdown permalink: /blog/:year/:month/:day/:title -paginate: 8 +paginate: 9 paginate_path: "/blog/page/:num/" -url: http://nodered.org -gems: [jekyll-paginate] +url: https://nodered.org +plugins: + - jekyll-paginate + - jekyll-redirect-from future: true +authors: + nick: + display_name: Nick O'Leary + url: https://github.com/knolleary diff --git a/_data/contributors.yml b/_data/contributors.yml new file mode 100644 index 00000000..a0c3d42e --- /dev/null +++ b/_data/contributors.yml @@ -0,0 +1,48 @@ +# Use https://caius.github.io/github_id/ to determine the githubId +- name: Project Leads + header: The creators of Node-RED, who continue to lead the project today. + people: + - name: Nick O'Leary + githubId: '51083' + links: + home: https://flowfuse.com + github: https://github.com/knolleary + - name: Dave Conway-Jones + githubId: '5375409' + links: + github: https://github.com/dceejay + +- name: Core Contributors + header: People who are regularly contributing to the core project or who have + made notable contributions in the project's history. + footer: Explore the full list here + + people: + - name: Ben Hardill + githubId: '1800845' + links: + home: https://flowfuse.com + github: https://github.com/hardillb + - name: Steve McLaughlin + githubId: '44235289' + links: + home: https://flowfuse.com + github: https://github.com/Steve-Mcl + - name: Gauthier Dandele + githubId: '92022724' + links: + github: https://github.com/GogoVega + - name: Kazuhito Yokoi + githubId: '20310935' + links: + home: https://www.hitachi-ac.co.jp/en/ + github: https://github.com/kazuhitoyokoi + - name: Hiroyasu Nishiyama + githubId: '30289092' + links: + home: https://www.hitachi.com + github: https://github.com/HiroyasuNishiyama + - name: Mauricio Bonani + githubId: '29807944' + links: + github: https://github.com/bonanitech diff --git a/_data/users.yml b/_data/users.yml new file mode 100644 index 00000000..08538f8d --- /dev/null +++ b/_data/users.yml @@ -0,0 +1,97 @@ +# Logo should be added under '/users/' +- name: All + users: + - url: https://www.echounify.com/ + logo: echo-unify-systems.png + - url: https://www.overview.ai/ + logo: overviewai.jpg + - url: https://www.ubos.tech/ + logo: ubos.jpg + - url: https://www.bitpool.com/ + logo: bitpool.png + - url: https://p4nr.com/ + logo: p4nr.png + - url: https://yoctoconnect.com/ + logo: connect.png + - url: https://www.umh.app/ + logo: united-manufacturing-hub.png + - url: https://www.simocowirelesssolutions.com/products/velocity/ + logo: simoco.jpg + - url: https://www.cosmonautasoftware.com/en-us/cosmo-psim-software-platform + logo: cosmo.png + - url: https://www.42flows.tech + logo: 42flows.jpeg + - url: https://www.broadsens.com/wireless-gateway/ + logo: broadsens.png + - url: http://chatbots.studio/ + logo: chatbots-studio.png + - url: https://www.plathome.co.jp/product/fw4/ + logo: plathome.png + - url: https://www.a4bee.com/ + logo: a4bee.png + - url: https://litmus.io/ + logo: litmus.png + - url: https://kontron-ais.com/en/ + logo: kontron.png + - url: https://tulip.co/ + logo: tulip.png + - url: https://iniationware.com/ + logo: iniationware.jpg + - url: https://www.cgignite.com + logo: cgignite.png + - url: https://www.prescientdevices.com/ + logo: pdi-logo.png + - url: https://handy.ai/ + logo: handyai.svg + - url: https://simplehw.eu/ + logo: simplehw.png + - url: https://openiap.io/ + logo: openiap.png + - url: https://smartlight.co.jp/node-red-lighting-iot/ + logo: smartlight.png + - url: https://www.hitachi.co.jp/products/it/oss/ + logo: hitachi.png + - url: https://www.dialog-semiconductor.com/ + logo: dialog.png + - url: https://zenzium.com + logo: zenzium.jpg + - url: https://www.vigilent.com + logo: vigilent.png + - url: https://entelligently.com + logo: entelligently.png + - url: https://st-one.io/ + logo: st-one.png + - url: https://www.aiomeet.com/ + logo: aiomeet.png + - url: https://www.thingtrack.com/ + logo: thingtrack.png + - url: https://www.enebular.com/ + logo: enebular.svg + - url: https://www.victronenergy.com/live/venus-os:large + logo: victron.png + - url: https://www.yellaumbrella.tv/ + logo: yellaUmbrella.svg + - url: https://www.veritone.com/ + logo: veritone.png + - url: https://www.flowake.com/ + logo: flowake.png + - url: https://sensetecnic.com/ + logo: sensetecnic.png + - url: https://agilite.io/ + logo: agilit-e.png + - url: http://dingo-iot.io/ + logo: go-iot.png + - url: https://www.spiritai.com/ + logo: spiritai.png + - url: https://www.multitech.com/ + logo: multitech.png + - url: https://www.opto22.com/ + logo: opto22.png + - url: https://www.iaconnects.co.uk/ + logo: iaconnects.png + - url: https://www.flowfuse.com/ + logo: flowfuse.svg + - url: https://www.qbee.io/ + logo: qbee.png.webp + - url: https://www.charge-unix.fr/ + logo: charge_unix.png \ No newline at end of file diff --git a/_includes/breadcrumbs.html b/_includes/breadcrumbs.html new file mode 100644 index 00000000..5d4e8e5a --- /dev/null +++ b/_includes/breadcrumbs.html @@ -0,0 +1,12 @@ + diff --git a/_includes/docs-content.html b/_includes/docs-content.html new file mode 100644 index 00000000..37df893f --- /dev/null +++ b/_includes/docs-content.html @@ -0,0 +1,28 @@ +{% include header.html %} +
+ {% include breadcrumbs.html %} +
+{% if page.toc %} +
+ {% include {{ page.toc }} %} + {% include toc-footer.html %} +
+
+{% else %} +
 
+
+{% endif %} +
+{% if banner %} +
{{ banner}}
+{% endif %} +

{{ page.title }}

+
{{ content }}
+
+
+{% unless page.toc %} +
 
+{% endunless %} +
+
+{% include footer.html %} diff --git a/_includes/docs-toc.html b/_includes/docs-toc.html deleted file mode 100644 index 5d976b6c..00000000 --- a/_includes/docs-toc.html +++ /dev/null @@ -1,64 +0,0 @@ - -{% include toc-footer.html %} diff --git a/_includes/footer.html b/_includes/footer.html index 489761a1..1a97b717 100644 --- a/_includes/footer.html +++ b/_includes/footer.html @@ -1,10 +1,9 @@