Docs
Csapattagok
- Kerecsényi Viktória
- Gavallér Bogát
- Agyagási Ferenc
- Neuvald Richárd
Setup
Telepítés és futtatás
-
Telepítsd fel a Cargo-t.
-
Futtasd le a következő parancsokat:
cargo install mdbook cargo install mdbook-alerts cargo install mdbook-external-links -
Futtasd a következő parancsal:
mdbook servevagy
mdbook serve -p [port]
important
Windows-on szükség van a Visual Studio C++ Build tools telepítésére a Cargo megfelelő működéséhez.
tip
mdbook serve parancs Live Server-ként működik, a megnyitott weboldalon a változásokat azonnal alkalmazza.
tip
VSCode-on belül javaslom a Markdown Preview Enhanced nevű plugin használatát. megnyitott markdown fájlon belül jobb klikk, és lesz egy opció ami megnyitja jobb oldalt a generált előnézetet.
Felépítés
- src/SUMMARY.md
- A bal oldalt lévő tartalomjegyzéket tartalmazza.
- Az első helyen lévő elem nyílik meg a főoldalon.
Chapter 1
Edit a file, create a new file, and clone from Bitbucket in under 2 minutes
When you’re done, you can delete the content in this README and update the file with details for others getting started with your repository.
We recommend that you open this README in another tab as you perform the tasks below. You can watch our video for a full demo of all the steps in this tutorial. Open the video in a new tab to avoid leaving Bitbucket.
Edit a file
You’ll start by editing this README file to learn how to edit a file in Bitbucket.
- Click Source on the left side.
- Click the README.md link from the list of files.
- Click the Edit button.
- Delete the following text: Delete this line to make a change to the README from Bitbucket.
- After making your change, click Commit and then Commit again in the dialog. The commit page will open and you’ll see the change you just made.
- Go back to the Source page.
Create a file
Next, you’ll add a new file to this repository.
- Click the New file button at the top of the Source page.
- Give the file a filename of contributors.txt.
- Enter your name in the empty file space.
- Click Commit and then Commit again in the dialog.
- Go back to the Source page.
Before you move on, go ahead and explore the repository. You’ve already seen the Source page, but check out the Commits, Branches, and Settings pages.
Clone a repository
Use these steps to clone from SourceTree, our client for using the repository command-line free. Cloning allows you to work on your files locally. If you don’t yet have SourceTree, download and install first. If you prefer to clone from the command line, see Clone a repository.
- You’ll see the clone button under the Source heading. Click that button.
- Now click Check out in SourceTree. You may need to create a SourceTree account or log in.
- When you see the Clone New dialog in SourceTree, update the destination path and name if you’d like to and then click Clone.
- Open the directory you just created to see your repository’s files.
Now that you’re more familiar with your Bitbucket repository, go ahead and add a new file locally. You can push your change back to Bitbucket with SourceTree, or you can add, commit, and push from the command line.
note
Highlights information that users should take into account, even when skimming.
tip
Optional information to help a user be more successful.
important
Crucial information necessary for users to succeed.
warning
Critical content demanding immediate user attention due to potential risks.
caution
Negative potential consequences of an action.