MirroredRepos/bat
1
0
Fork 0
mirror of https://github.com/sharkdp/bat.git synced 2025-02-07 13:41:14 +00:00
Code Issues Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
sharkdp 2020-04-22 19:23:45 +02:00 committed by David Peter
parent ec0ce05455
commit eee35e54e9
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/lib.rs
View File

@ -1,5 +1,12 @@
//! `bat` is a library to print syntax highlighted content. //! `bat` is a library to print syntax highlighted content.
//! //!
//! The main struct is `PrettyPrinter` which can be used to configure and
//! run the syntax highlighting.
//! If you need more control, you can also use the structs in the submodules
//! (start with `controller::Controller`), but note that the API of these
//! internal modules much more likely to change.
//!
//! "Hello world" example:
//! ``` //! ```
//! use bat::PrettyPrinter; //! use bat::PrettyPrinter;
//! //!