This project is the Docusaurus build of the Climate Tech Handbook, a comprehensive resource that aims to provide valuable insights, knowledge, and tools to navigate the complex landscape of climate technology.
The Climate Tech Handbook serves as a central hub for information related to climate tech, covering various topics such as renewable energy, sustainable agriculture, carbon capture, climate finance, and more. It is designed to support researchers, entrepreneurs, policymakers, and individuals passionate about driving positive climate impact.
The current test build can be accessed at docusaurus.climatetechhandbook.com (Password: test).
- Prerequisites
- Setup
- Local Development
- Build
- Content Management with Decap CMS
- Deployment with Netlify
- Contributing
- Acknowledgements
- Contact
- License
- Node.js version >= 12.13.0 or above (which can be checked by running
node -v). You can usenvmfor managing multiple Node versions on a single machine installed - npm version >= 6.12.0 or above (which can be checked by running
npm -v)
- Clone the repository:
git clone https://github.com/climate-tech-handbook/docusaurus-test.git- Change to the directory:
cd docusaurus-test- Install the dependencies:
npm installStart the development server:
npm startThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
To create a static build of the project:
npm run buildThis command generates static content into the build directory and can be served using any static contents hosting service.
This project uses Decap CMS for content management. For instructions on how to use Decap CMS with this project, please refer to Decap CMS documentation.
This project is deployed with Netlify. For instructions on how to deploy this project with Netlify, please refer to Netlify documentation.
We welcome contributions to the Climate Tech Handbook. Please see our Contributing Guide for more information.
This project represents an ongoing effort to transition the Climate Tech Handbook from its original form, built with MKDocs, to a new build powered by Docusaurus 2. The initial version of the handbook can be found at this repository.
In the course of this transition, we are not only changing the static site generator but also integrating our backend, which was initially built as a separate Flask application in the data-magic repository. Our goal is to streamline development and maintenance by consolidating these resources into a single, cohesive monorepo.
We are grateful to all contributors who have participated in this project. Your time and expertise are greatly appreciated. We are always open to new contributors and look forward to the continued growth and improvement of the Climate Tech Handbook.
For any queries, suggestions, or contributions, please reach out to us:
This project is licensed under the terms of the MIT license.
The MIT License (MIT)
Copyright (c) <2023> Climate Tech Handbook
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.