GitBook - GitHub integration

Video Statistics and Information

Video
Captions Word Cloud
Reddit Comments
Captions
Hi and welcome back. In the previous video, I show you how you can create a simple website using GitBook. Now that you know how to use their web editor, we're going to enable sync with get up. I think this is an extremely useful feature because you're going to be able to see your markdown file that you have locally on your computer with deep Booker, and this integration, I think is extremely powerful. So what we're going to be able to create at the end is something along the lines of whatever the data for my website for the CB demo. So here as you can see I have my did broker website that I created that with the landing page navigation. And so for that, any I have all my markdown files that I ever seen COVID So every time I change the file here, for every time I change the document using their web editor, I will be able to see the changes automatically. So let's get started. But before we get started I just would like to take a second to remind you to like this video and subscribe to my channel. If you find this video interesting, and if you want to find out more and being notified when I release a new video. Just don't forget to press the bell icon so let's get started. So last time we created the space called YouTube. So let's open it again and check what is inside this one these are they find the time inside. So this time, this time we want to share these five year with our GitHub repository, and we want to see them. So the first thing that I would recommend you to do is to use any ID of your choice. I'm going to use Python. In my case, feel free to use VS code, if you prefer. The same thing will apply and I will show you step by step how to do it by the terminal, so no worry if you're not familiar with Python. We're going to create a new project that we're going to be in the loads, and we're going to call it a YouTube. And then we're going to use a Python interpreter which is Python 3.9 and we are going to create a main.py Welcome screen. I'm going to create a Python project doesn't have to be a final project, of course, it could be a React project, it could be an art project that any project of your choice. In fact, you don't even need to have a project by itself, you can just have a good book. However, I want to show you how you can organize very nice and neatly, your documentation. If you have a project, because there is one important step that we need to follow, so let me increase the font size. So here we have our Python project, which we have for you tuber, which is the root directory which we just created and inside we have our main.py file. Okay, so there are a couple of things that we need to do. I'm sure you probably have already done it. If you have a project that you want to sync with the broker, let's do all the steps and so all of you can follow along. The first thing that we're going to do is to do it. And here I have the terminal, open in Python, the terminal at the bottom, but you can also do it from the command line or from the terminal. And let's go inside the YouTube directory. So here we are, see user my name, allows you to want to do good. That's the first step, then the second step in my case, since I'm using Python I'm going to click New. I'm going to click on, ignore file Sir, I'm going to create a Git ignore file here, Sophia Sharma offers me to use like some templates so I'm going to select the Python because a Python project and is JetBrains, so he's going to not seeing the dot IDF file, which is configuration folder that automatically creates, so we're going to generate this file. And inside here, the ps1 file will only container, basically, the file that you want to ignore. So in my case this is done automatically by Python. Then we are going to go here at the bottom, and we're going to say get out the doctor since we want to add all the files here, and we have actually the main file now that is going to turn green, so that's perfect because we want to sync that file. And the next step is that we have to move to Mexico, the browser, we need to go inside get up here and create a new repository, okay to keep it consistent I'm going to call it actually doesn't have to have the same name residues and other name and we're going to say get bucur there. Sure, you forgot to make it public, it doesn't have to be public, it can also be private that afternoon, is going to be you're going to be able to see it anyway even if it's private, and you're going to create a repository we don't want to add a license or get ignored or leave behind because we have already done that, of course, in order to create reports from the top, you need an account and I've already logged in. So I'm going to create the repository, and I'm going to just copy the code that we have here, so we have a git remote region. And then we're going to copy this code here. Let's go back to pi charm to the terminal here at the bottom, and we just paste this one of course we could have done it in another way by our their gate tool, But, we're going to do it from the terminal so every one of you can follow along. So we're going to add the region and in my case I don't want to change the name of the master branch. So by historically the master branch that was generally created when you initialize our Git Repository was called Master guitar but wanted to change his name and call it mean, so just keep in mind that if you change the name of the branch with me in from Master then wherever you bought it didn't work or we just need to be considered of that. We're not going to change the name. In our case we are going to keep it a good call it good. Webmasters audit, and you're never going to Tokita meter, and then we're going to say, dash m MSA first for me. So then the last command that we need to do is get pusher set upstream origin master, because what I told you before we need to just make sure that we create these upstream. Master, so we can press enter, and this is going to push our file to the GitHub repository so the GitHub repo is good as you can see right now it's empty, but if I refresh this page, technically I should see all the bytes, as you see ignore these dot IDF file is not necessary. So these was the first step but now the next step that we need to do, and it is very important in order to keep our good book by organized that is to get polka dot Yamo file in order to add the get book dot Yamo file we just have to go back into my Charma, here we are so we click here on YouTube, right click New, and then we're going to pick file, and this file is called Dr. Walker, not damaged by a file. So inside this file here we are going to add it to Gita, from now on I'm not going to use the Terminator anymore to do the kosher, I'm going to use the by charm because I think it's easier but I just show you all the steps and you can just do it. If you want to so I'm going to add the, you wouldn't say get out there and then the name of this file, but then what we need to specify inside this file here is router, and then we're going to say, Docs, let me explain what I'm doing here. If you don't do this, if you don't specify that to get broker that the root directory is a doctor towards slash docs, which this folder does not yet exist. When we are going to import all the things, and all the files that we have here basically. So in our project. So all these files here. All these file are going to go into the root directory so the main directory that is going to be annoying because we're going to see a lot of new Markdown file here, at the same level of our Python file, but we want to keep our documentation or at least I prefer to keep my documentation nice and organized inside a subdirectory called Doc's. That's why I'm adding this Yaman file here, because I'm specifying the root directory for all digital files are going to be in the docs folder. So let me show you these. And we need to commit these changes. So in Python, I want to press Ctrl T, and then I'm going to press like I'm going to say fifita I'm about to explain what I've done. So, created the booker dot YAML fine, and we're going to commit and push this change, which I can do in Python with counterpart Kay, and then I can push these changes to the Git repository. So here if I go back in here and I refresh it. Now we're going to see the Yamo file that we just have added fantastic if you can see this file here. Let's go back to the online interface of poker. And let's do the last step. The last step is to click here on integrations. On the left we can see this toggle your date of birth, so let's click on Deezer, I'm going to leave all the public repositories, because I created that repository to be public. However, if you're treated as private repos. Let's click here on these repositories. I've already linked my account or my GitHub account with GitHub, so it's not asking me to log in. But in case you haven't done it already, just log in and follow the instructions on how to log in and how to see it look with it up. I'm going to be called release the only public repositories. I'm going to search for the repository that we just created. So the repositories for good YouTube. Okay, you want to press Next. and here is what I mentioned before, so if you have to the name Master is by default, see master branch quality. Alternatively, you have to click here and you have to put the mean, if you call it mean okay but you are going to kill, keep it safe master branch quality, we're going to press next. I write in my contract on GitHub, or on gitbook, but we started our project on the book, so we're going to select the second option. However, no one stops you to write the contract first on GitHub, but in this case we have already started our project on GitHub. So next project, you can start on GitHub, but in this case we already started this once you have to select the second box. Please keep in mind that this is very important to understand is just for the first synchronization, later on you can work, either on their web tool, or you can use local even work locally. So I'm going to click here. Next, and this is setting up a GitHub integration. So, let's see what is doing is exporting the content that's what we want. Fantastic. So now, is ready we can just go outside, we can go back here to get book or YouTube example, we can do a refresh of this page here. And as you can see we can see the docs folder, we have our README file and a summary file, and inside here we have our group, which was contribute code of conduct. And we have some deep work assets, which is our image. So that's great. We were able to import all these things. The last step is to go back to my Charmat invites are my cookie folder. I'm going to do Ctrl D, which is going to merge incoming changes into the current branch, I'm going to press OK. Let's go. Here at the top. ls view the project. So, here what are despite the two most important file that you need to know is the readme, which is our landing page, Peter in good Booker, so this is the landing page, and we have summary, summary is the table of contents that you can see on the left, so let me show you what what do i What do I mean with that. So if I go here on it. We can see that the, This is the landing, this is the table of contents on the left, and these reflects exactly what is in your revenue, initial beta Code of Conduct index and guides for the conduct index. Okay, so this is what we have. And inside here we have guides. But then here inside initial page, we are important in the readme dot Markdown file, and if I open this file here, I have, sorry, not that one is one here, we have initial page introduction and this text. Let's go back there and we can see that the initial page is introduction things text, and the sub section. Now let's see how we can enter water from one side on the other. So let's start with the local repository, we want to change this tax because it makes no sense. Okay. The other thing that we want to add is another group so we're going to create a new directory inside here, we're going to call it getting started, and I can just use dashes, getting started in this so I'm going to create the folder. Inside the folder I'm going to create a new file and I'm going to call it intro, Doctor markdown. So we are going to add it to get that is a very nice functionality of HRM and we're going to call it that intro to getting started. And here, inside we can write, how to get started. Of course I'm not going to go too much into detail because I just want to show you the GS. And then of course you're going to be able to change that yourself. But, before we commit this change and we push you to get out but we need to be very careful that we are the teaser, new group, and his new filer, inside the summary. So how can we do that, well, we can just copy what was done here, so let's just copy here, and we're going to say year we're going to go into getting started. And here we're going to call it introduction. And here we just have to refer the file, offer the getting started so where is the file using getting started or what does Lasha intro dot markdown. So now we're ready to go. We do Ctrl K, in my case, which will be committed to the changes and push. Of course you can use the terminal. So let's do Ctrl, Alt K, actually let me change the commit message. Create a getting started. And then, on the royalty, we're going to push these changes to the GitHub repository, and we can go back here and we should be able to see that this pager will automatically refresh fantastic as you can see wasn't a real time, and we can see getting started, then we have the introduction, how to get started. And then I continue this file here with it. Of course I can click on saver manager. And if I go back here and if I go into a drawer, and I do a CTRL T, and I merge the current changes, and I press OK. We should be able to see the new commit. We say we. That's great. So we were able to do everything, and we were able to save the project. Now, it's just up to you to change the documentation, as you please and as you want. As you can see you can use their online editor, or whatever you prefer. I just have one final recommendation for you is that if you want to decide endings, you could just want to write text that's super simple, you can just use a simple syntax in Markdown. And if you're using, like for instance by char by char helps you, because as you can see you can convert the text to Retallick, or you can put stripe through, or you can put the code and so forth. however, it Booker uses a flavor of markdown for karate. Let's go back to the readme here, where we added an image. Okay, so the image actually there is nothing strange but let me show you later on how to add a video, I would recommend you to add a video or video link from the web, to understand how they import the video, and then later on you can also other video here locally, but let me show you that. So that means the first other images I'm going to load an image and put it here so I can go to Unsplash here. I'm going to pick the first one doesn't really matter, is just to show you how to do it. So here we are saving into the loader and we're going to call it, image, we are going to save it in dachser, here. So here I can open Internet Explorer. So here I have my file, I can go in downloads, and then I can get this image and I'm going to change the name, image. I'm going to press Ctrl X, and then I go back to the previous directory here we go to dachser, because we did Buka assets. And inside here we're going to put the image. Now that we have the image, we can go back to pi karma, we can copy this for the URL if you don't know how to add an image or otherwise you could have just simply write it and we can go here into d3 Now to get started. Notice what an image or let me show you, actually, is exclamation marker, and then you have square braces, and here we have the era, I need to go one level up, and then I need to use equal classes image dot jpg. Let's see if everything was successful, so we can go back here, and we should be able to see the image. If everything worked fine. One last thing that I haven't shown you how to do it last time and I want to show you this time is how for instance to embed a video, so I'm going to get a video of my own, so we can go here we just have to paste in the link of the video, and automatically you press enter and the GitBook will add a link to your video. We save. Marija. And then we go back to pi charm, Ctrl T, and we are going to be able to see all our two other videos into markdown, using a key. So this is how you can embed a video, so let me just remove data so you have to use these curly braces, where percent symbol, embed, and then we have URL, and then we just need to put the URL of the video. I really hope you find this video interesting and useful if you did please consider liking the video and subscribing to my channel, it really helps. If you also want to find out how to create a website, or documentation website that with another tool like office hours, I will put the link to those arrows down in the video description and you should be able to see a card at the end of the document. If you want to support this channel you can do so by buying me a coffee or supporting me on Patreon, more information in the video description below. And thank you very much for listening and see you in the next video.
Info
Channel: Federico Tartarini
Views: 693
Rating: undefined out of 5
Keywords: gitbook tutorial, gitbook github, gitbook alternative, gitbook github integration, gitbook documentation
Id: d4s0Ks0e-tA
Channel Id: undefined
Length: 17min 42sec (1062 seconds)
Published: Mon Sep 27 2021
Related Videos
Note
Please note that this website is currently a work in progress! Lots of interesting data and statistics to come.