search

openfab-lab / rtfm

THE openfab manual. Will be the source of all knowledge in the lab, nicely published on gitBook
https://openfab.gitbook.io/rtfm/
Creative Commons Attribution Share Alike 4.0 International
0 stars 0 forks source link

learn gitbook #1

Open nicolasdb opened 5 years ago

nicolasdb commented 5 years ago

The original purpose of this GitBook was to illustrate how to create all manners of internal and external links using Markdown and HTML in a GitBook. It has now morphed into my experiments with gitbook. Hopefully it remains useful to all who seek the knowledge.

https://seadude.gitbooks.io/learn-gitbook/content/

nicolasdb commented 5 years ago

To add content follow

  1. Root = files like readme.md (intro) and summary.md (toc on the left)
    1. /community, a folder named like your main chapters.
      1. your sub chapters.md
      2. your sub chapters.md
      3. your sub chapters.md
  2. .gitbook/assets/ will content your images for exemple.

Link look like that:

* [Community](community/README.md)
  * [Fablab](community/fablab.md)
  * [Services](community/services.md)
  * [Workshops](community/workshops.md)
  * [Appels à projet](community/appels-a-projet.md)

Images look like that: ![pic](.gitbook/assets/memebers_01.png)

Then I faced some issues with the link between github<>gitbook It's kind of linked with cached memory. If I change images on the folder .gitbook/assets/memebers_01.png, it will not specially get well updated on gitbook. It's good to hit crtl+F5 sometimes and.or try others things, just tinker with it. I finaly get the job done.

note: if you use Atom to edit your md files. image If you copypasta project path for assets, Atom use relative link with \ but you need to use regular / in files Path. I use the find/replace to correct that

nicolasdb commented 5 years ago

basically,

test a page on your account and edit from gitbook and look what are the changes in github, and back, to see how thing change and show.

It's fine to edit directly in gitbook if you are working alone. But to master the edition through github is a must have to be able to edit a document as a collectif.

for example.

Openfab, as a collectif, we want to use this book as the rules. It the law. It means that we need to decide together what we use as rules. And to have a protocol to complain about a rule, explain and propose a better rule to fit the situation. Then to accept or to discuss if needed then, finally, publish this new rule on the book.

For that, I want to use the loop. Issue + cop, branch + proposal, PR + comment, review by peers and merge into "Master branch"

nicolasdb commented 5 years ago

Haaa, maybe not but mostly, it's best to work on github. It still not resolve review and decision making. image

nicolasdb commented 5 years ago

Anyways. To start and setup the TOC, the structure, it's easier to do it in gitbook than jingling with folders in github online.... not for noobs