E4-notes

E4-notes

A collection of (not so) short notes for the Electronics IV course, lectured at Aveiro University

#notes#markdown#pandoc#jekyll#instrumentation#electronics#microcontroller
Demo Download

E4-notes

A collection of useful notes and pdfs for the Electronics IV course at Aveiro University.

A website is also available here.

Published Notes

[WIP]

Note taking process

  1. Notes are taken using pandoc markdown extended syntax
  2. Using pandoc, the notes are converted into a eye-candy pdf, using tex as an intermediary file type
    • The latex compiler used is xelatex
    • The Eisvogel template is used with small modifications
  3. Using an yaml header, some metadata and rendering options are provided
  4. Some of the used diagrams are generated using either dot or tikz. The remaining were copied from the course slides.

DOT & Grphviz

The dot graph description language is a graphic description language, enable the fast creation of reasonably neat diagrams

For interpreting the dot code, graphviz as used.

For more information on dot and graphviz, check out this amazing guide

Tikz

The Latex vector graphic language, Tikz, that uses geometric/algebric description to create beatiful diagrams

For more information, check out this amazing guide

Publishing

To ease the publish of an eye-candy pdf:

 # Assuming that exists a metadata file named notes.yaml in the metadata folder
./renderpdf <notes.md>

# Assuming a metadata file is going to be provided
./renderpdf <notes.md> <metadata_file.yaml>

Disclaimer

Currently this work is highly experimental and not yet scientific reviewed. Do not trust this notes by themselves. They are meant to complete other materials, not replace them.

Acknowledgement

This work is a direct product of the lectures notes toked during Electronics IV classes in the academic year of 2017/18, lectured by Prof. Pedro Fonseca.

This raw notes were later improved and filtered using as scientific reference the lecture slides from Prof. Pedro Fonseca.

Roadmap

  • Curate Raw notes
  • Improve the publishing scripts
  • Improve the publish template
  • Provide a static website with all the notes

License

The content of this project itself is licensed under the Creative Commons Attribution-ShareAlike 4.0 International license and the underlying source code is under the MIT license.

minimalacademicresumeportfoliodocumentationwikitailwindbootstrapdarkecommercegithub-pagesblog