Installation

Installing deski

Deski was designed from the ground up to be easily installed and used to get your website up and running quickly.

                    npm i deski-cli-g

{/* /.mark-blue */}

Verifying Installation

If you want to write the documentation in the{" "} ./docs subdirectory, you can use the{" "} init command.

deski init./docs

{/* /.mark-red */}

Create a project, if none exists, and change your directory to this project's root.

You will be creating the docs in this directory. The root directory may contain other files. The Docusaurus installation script will create two new directories: docs and{" "} website.

some text missing

{/* /.mark-red */}

                    if you don't have Node 1.8.2+ or if you prefer to install
                    deski globally, run{" "}
                    yarn global add deski-init or{" "}
                    npm install --global deski-init.
                    After that, run docusaurus-init.

{/* /.mark-blue */}

Manual Installation

If you don't like npm or have trouble installing the tool, you can manually create index.html:

                  
                    <!-- index.html -->
                    {"\n"}
                    <!DOCTYPE html>
                    {"\n"}
                    <html>
                    {"\n"}
                    <head>
                    {"\n"}
                    
                      {"\n"}
                      <meta http-equiv="
                      X-UA-Compatible"
                      content="
                      IE=edge,chrome=1">{"\n"}
                    
                    
                      <meta name="viewport"{" "}
                      content="
                      
                        width=device-width,initial-scale=1
                      
                      ">{"\n"}
                    
                    
                      <meta charset="UTF-8">
                      {"\n"}
                    
                    
                      <link rel="stylesheet"{" "}
                      href
                      ="
                      
                        //cdn.jsdelivr.net/npm/docsify@4/themes/vue.css
                      
                      ">{"\n"}
                    
                    </head>
                    {"\n"}
                    <body>
                    {"\n"}
                      {" "}
                    
                      div id="app">{"\n"}
                    
                       </div>
                    {"\n"}
                       
                    <script>
                    {"\n"}
                    
                            window.$docsify = {"{"}
                    {" "}
                    {"\n"}
                    
                            //....
                    
                    
                      {"\n"}
                            {"}"}
                    {" "}
                    {"\n"}
                       </script>
                    {"\n"}
                      
                    
                      <script src="
                      
                        //cdn.jsdelivr.net/npm/docsify@4
                      
                      ">
                    
                    </script>
                    {"\n"}
                    </body>
                    {"\n"}
                    </html>

                    Note that in both of the examples below, docsify URLs will
                    need to be manually updated when a new version of deski is
                    released (e.g. some text missing ). Check the docsify
                    website periodically to see if a new major version has been
                    released.

{/*/.mark-blue */}

Running Example Website

After running the Deski initialization script, docusaurus-init as described in the Installation section, you will have a runnable, example website to use as your site's base. To run:

It can have an identifier which is either a number or a string.
Loads navbar from the Markdown file _navbar.md{" "} if true, else loads it from the path specified.
Load the example site at http://localhost:3000{" "} if it did not already open automatically. If port{" "} 3000 has already been taken, another port will be used. Look at the console messages to see which

Launching the server

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be using the{" "} NO_PROXY environment variable.

                    window.$deski = {"{"}
                    
                      {" "}
                      
 name:{" "}
                      
                        '<span>deski</span>'
                      
                      , 

                    
                    {"}"}

{/* /.mark-red */}

Loading dialog

                    <!-- index.html --> 

                    

                    <div id="app">Please
                    wait...</div>

{" "} {/* /.mark-red */}

You should set the data-app attribute if you changed el :

                    <!-- index.html --> 

                    

                    <div data-app id="main
                    ">Please wait...</div> 

                    <script>
                    

                      {" "}
                    
                      window.$docsify = {"{"} 

                    
                      {" "}
                    
                      el: '#main'
                    
                    
                      {" "}
                      
 {"}"}
                    {" "}
                    

                    </script>

{/* /.mark-blue */}

You can update to the latest version of Docusaurus by:

                  
                    
                      yarn upgrade deski --latest

{/* /.bg-black */}

Quick Start
Site Preparation