The development notes are written in Markdown format and converted to an EPUB file. Your eBook reader or viewer app can import this converted EPUB file.
For the best experience, disable the auto-shutdown feature of your eBook Reader and place it next to your keyboard to always show your development notes.
Photo by Megafilm on Freepik
- Xelatex - Convert Markdown to PDF file format
- Dejavu Sans - Font
- Clone this GIT repository:
git clone https://github.com/dejavu-fonts/dejavu-fonts.git- To create the EPUB file, you can execute
makeor the following command line:
pandoc -f markdown -o dist/dev-notes.epub --metadata-file=doc/metadata.yml doc/dev-notes.md --toc --toc-depth=3The dist folder will then contain the converted dev-notes.epub file. Import dev-notes.epub file into your eBook reader or open it in an eBook viewer app.
- To create the PDF file, you can execute
make pdfor the following command line:
pandoc -f markdown -o dist/dev-notes.pdf --pdf-engine=xelatex --metadata-file=doc/metadata.yml doc/dev-notes.md --toc --toc-depth=3The dist folder will then contain the converted dev-notes.pdf file. Import dev-notes.epub file into your eBook reader or open it in an eBook viewer app.
- Visual Studio Code - Editor
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
- Marco Koch - Initial work
Copyright (c) 2020 Marco Koch.
This project is licensed under the Creative Commons Attribution Share Alike 4.0 International (CC-BY-SA-4.0) - see the LICENSE file for details
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the LICENSE for the specific language governing permissions and limitations under the License.