Cách tạo Wiki nội bộ đơn giản bằng Gitbook

GitBook là một nền tảng cho phép bạn xây dựng các trang web tài liệu hoặc wiki của công ty. Bạn có thể sử dụng nó để ghi lại tất cả mọi thứ, từ mã đến API và cách sử dụng một sản phẩm phần mềm.

GitBook sử dụng quy trình tương tự như kho lưu trữ GitHub. Bản sao chính của tài liệu hoạt động như một bản sao 'chính'. Sau đó, bạn có thể tạo 'bản nháp', tương tự như 'chi nhánh'.

Quá trình này cho phép nhiều người dùng làm việc trên một trang tài liệu duy nhất trong khi xử lý hoặc ngăn ngừa xung đột. Nó cũng cho phép các thay đổi từ các nhánh khác nhau trải qua quá trình xem xét trước khi bạn hợp nhất chúng.

Cách bắt đầu sử dụng GitBook

Bạn có thể chọn từ một số Giá GitBook các kế hoạch. Việc định giá sẽ phụ thuộc vào việc bạn đang sử dụng GitBook cho các dự án mã nguồn mở, sử dụng cá nhân hay cộng tác nhóm riêng. GitBook được sử dụng miễn phí nếu bạn đang sử dụng nó cho các dự án mã nguồn mở.

GitBook hỗ trợ Markdown, một ngôn ngữ đánh dấu phổ biến với nhiều lợi ích để viết hoặc tài liệu trên web.

GitBook cũng tích hợp với GitHub, một nền tảng để lưu trữ, lưu trữ và chỉnh sửa mã . Bạn có thể liên kết tài khoản GitBook của mình trực tiếp với tài khoản GitHub bằng cách đăng nhập bằng thông tin đăng nhập GitHub của bạn.

cách tải tất cả ảnh từ đám mây samsung

Đăng ký GitBook. Nếu bạn có tài khoản GitHub của riêng mình, bạn có thể nhấp vào Đăng ký với GitHub .
Khi bạn đã đăng nhập, GitBook sẽ chuyển hướng bạn đến một wiki nội bộ mới. Nó cũng sẽ điền trước vào wiki của bạn một số nội dung mẫu.

Tổng quan về Giao diện GitBook

GitBook có một số chức năng cho phép bạn xây dựng và thực hiện các thay đổi đối với trang web tài liệu của mình.

Bảng điều khiển trên cùng cho phép bạn tạo bản nháp mới, xem lịch sử thay đổi hoặc xem bất kỳ cuộc thảo luận hoặc tệp đính kèm nào khác.
Thanh bên ngoài cùng bên trái cho phép bạn tạo nhiều khoảng trắng. Bạn có thể sử dụng các không gian riêng biệt cho các dự án khác nhau để có thể tách biệt và sắp xếp các khu vực tài liệu của mình. Bạn có thể mở rộng hoặc đóng thanh bên.
Bảng điều khiển bên trái hoạt động như một menu cho trang web tài liệu. Bạn có thể xem các trang trong trang web tài liệu của mình và sử dụng nó để tạo các nhóm và các trang lồng nhau. Bạn cũng có thể điều hướng trên trang web bằng cách sử dụng các liên kết được cung cấp.
Bảng điều khiển phía dưới bao gồm các nút quan trọng đối với quá trình kiểm soát phiên bản. Bạn có thể thêm tên cho bản nháp của mình, hợp nhất một thay đổi hoặc gửi thay đổi để được xem xét.

Cách tạo bản nháp mới

Bạn có thể tạo bản nháp mới bằng cách tạo Yêu cầu thay đổi mới và thực hiện các thay đổi trong đó.

Trong bảng điều khiển trên cùng, hãy nhấp vào Thay đổi yêu cầu .
Trên bảng điều khiển mới xuất hiện ở phía bên phải, hãy nhấp vào Bản thảo chuyển hướng. Điều này sẽ hiển thị cho bạn tất cả các bản nháp đang hoạt động của bạn.
Từ đây, bạn có thể nhấp vào một bản nháp hiện có để mở nó. Để tạo một bản nháp mới, hãy nhấp vào Yêu cầu thay đổi mới và đợi trang tải xong.
Trong bảng điều khiển dưới cùng, nhấp vào Nhập chủ đề . Thao tác này sẽ mở ra một cửa sổ nơi bạn có thể đặt tên cho bản nháp mới. Ví dụ, Trang mới - Cách thiết lập Codebase .

Cách tạo Trang và Nhóm

Sau khi có bản nháp, bạn có thể bắt đầu thực hiện các thay đổi đối với tài liệu. GitBook lưu trữ các thay đổi của bạn bên trong bản nháp, vì vậy chúng không ảnh hưởng đến bản chính. Bạn có thể sử dụng thanh bên bên trái để thêm các trang và nhóm trang.

Tạo một trang mới bằng cách nhấp vào Trang mới ở cuối thanh bên và chọn Trang tài liệu mới từ trình đơn thả xuống. Ngoài ra, bạn có thể di chuột bên dưới một trang hiện có và nhấp vào màu xanh lam thêm cái nút.
Để tạo một Nhóm Trang mới, hãy nhấp vào Trang mới và chọn Nhóm mới tùy chọn từ trình đơn thả xuống.
Bạn có thể đổi tên trang bằng cách nhấp vào dấu ba chấm bên cạnh trang hoặc nhóm và chọn Đổi tên .
Bắt đầu thêm nội dung để điền trang mới của bạn. Bạn có thể thêm nội dung đơn giản như văn bản hoặc tiêu đề. GitBook cũng cho phép bạn thêm các khối nội dung khác như hình ảnh, tệp đính kèm, bảng, tab hoặc đoạn mã. Ngoài ra còn có tùy chọn để thêm các tích hợp khác như nội dung nhúng trên YouTube hoặc nội dung Google Tài liệu.
Bấm vào Chế độ xem khác biệt trong bảng điều khiển dưới cùng để xem sự khác biệt giữa bản nháp của bạn và bản sao tài liệu chính gốc.
Khi bạn đã viết xong nội dung của mình, bạn có thể nhấp vào Hợp nhất , Gửi và hợp nhất , hoặc Gửi để xem xét .

Cách tạo liên kết đến trang tài liệu

Bạn có thể truy cập liên kết chia sẻ từ bảng điều khiển trên cùng của GitBook. Bạn sẽ cần phải ra khỏi bản nháp và xem bản sao tài liệu chính để có thể xem liên kết.

Theo mặc định, khả năng hiển thị của trang web tài liệu của bạn là 'không công khai'. Điều này có nghĩa là bạn có thể truy cập trang web tài liệu bằng liên kết riêng tư chứ không phải thông qua công cụ tìm kiếm. Trong bảng điều khiển trên cùng, hãy nhấp vào Không công khai cái nút.
Chọn cài đặt hiển thị mong muốn của bạn từ menu thả xuống. Lưu ý rằng GitBook có thể khóa các cài đặt hiển thị nhất định và bạn có thể cần phải nâng cấp để truy cập chúng.
Bên dưới danh sách cài đặt hiển thị, có một liên kết mà bạn có thể chia sẻ với những người dùng khác sẽ sử dụng trang web tài liệu của bạn. Sao chép liên kết này để chia sẻ nó với những người khác.
Bên dưới liên kết, nhấp vào Liên kết và cài đặt miền . Đây là nơi bạn có thể liên kết một tên miền tùy chỉnh hoặc sửa đổi một phần của URL. Nếu bạn đang sử dụng miền tùy chỉnh, bạn có thể xem Tài liệu của Gitbook về cách định cấu hình chính xác DNS của bạn.

Tạo tài liệu bằng GitBook

GitBook cho phép bạn cộng tác tạo và làm việc trên các trang web tài liệu hoặc wiki của công ty. GitBook vay mượn các khái niệm từ GitHub như các chi nhánh và hợp nhất để kiểm soát bản sao chính và quản lý mọi xung đột.

Bạn có thể tạo một bản nháp mới để thêm các thay đổi của riêng bạn vào tài liệu. Trong bản nháp, bạn có thể thực hiện các thay đổi đối với nội dung, cũng như thêm các trang hoặc nhóm trang mới. Sau khi thực hiện xong các thay đổi, bạn có thể hợp nhất hoặc gửi chúng để xem xét.

Nếu bạn đang tạo tài liệu nội bộ cho mã Java của mình, bạn có thể muốn khám phá Javadoc. Javadoc cho phép bạn ghi lại mã Java của mình một cách tự động.