DEV Community 👩‍💻👨‍💻

DEV Community 👩‍💻👨‍💻 is a community of 964,423 amazing developers

We're a place where coders share, stay up-to-date and grow their careers.

Create account Log in
naveennamani
naveennamani

Posted on • Updated on

Offline documentation of tailwindcss in 5 easy steps

This post is a 2nd one in the Offline documentation series. If you're new here check out my first post.

Generate offline documentation of reactjs in 5 minutes

For more scripts like this, please visit my offline-docs github repo currently contains more than 30 scripts.

In this post, let's build the offline documentation for tailwindcss, my favorite utility first CSS framework, and my go to CSS framework for rapidly prototyping a design.

Getting the source code

The documentation for tailwindcss is available on tailwindcss.com website. We can easily find the source code for this website on github through a simple google search. It is hosted on github at https://github.com/tailwindlabs/tailwindcss.com.

Let us first download the source code and inspect.

git clone https://github.com/tailwindlabs/tailwindcss.com
cd tailwindcss.com
Enter fullscreen mode Exit fullscreen mode

Open the code editor of your choice. If using vscode, just enter

code .
Enter fullscreen mode Exit fullscreen mode

Understanding the tech stack

If we look at the files in the root directory, we can understand that

  1. next.config.js - The website is written in nextjs
  2. tailwind.config.js - The website is build using tailwindcss as the CSS framework (what else you expect?)
  3. yarn.lock - using yarn as the package manager

For understanding the deployment process of nextjs, we can simply go to its corresponding documentation website. You can find the information in below links.

  1. Deployment | Next.js
  2. Advanced features: Static HTML Export | Next.js

package.json

Once you gain enough info on how deployment works, let's open package.json file and see if we have the required scripts already present. Luckily, we have the script export for generating static files. Our life has been made easier already.

Scripts in package.json file

Commands

Now we have enough information to generate the documentation.

  1. Install all the dependencies using the yarn package manager.

    yarn install
    
  2. Run the build script using

    yarn export
    

    This will generate the required static HTML, js, css and all assets in the out folder.

  3. Serve the documentation generated in out folder

    cd out
    python -m http.server // simpler
    // Or if you prefer nodejs
    yarn global add serve
    serve
    

Congratulations! We now have tailwindcss documentation available offline.

If you would like to have offline documentation for any framework/library you require, please tell us in the comments.

Pro tip for vscode users

jsconfig.json

If you have the following directory structure

Home
\- components
   |- A.js
   |- B.js

utils
\- utils.js
Enter fullscreen mode Exit fullscreen mode

and want to import utils.js in A.js, you need to use relative paths as follows

import utils from "../../utils/utils.js"
Enter fullscreen mode Exit fullscreen mode

This makes it harder to follow the file being imported, and once you have a folder structure 3 or more levels deep, this makes it even harder to write the required imports keeping in mind all the folders.

jsconfig.json to the rescue!

You can use "compilerOptions" > "paths" dictionary to define the path mappings relative to the root of the project.

{
    "compilerOptions": {
        "paths": {
            "@/utils/*": ["utils/*"],
            "@/home/*": ["Home/components/*"]
         },
    }
}
Enter fullscreen mode Exit fullscreen mode

Now instead of all those relative paths to import utils, you can simply use

import utils from "@/utils/utils.js"
Enter fullscreen mode Exit fullscreen mode

to import the utils, and to import A.js in any other file, we can write

import A from "@/home/A.js"
Enter fullscreen mode Exit fullscreen mode

You can see this jsconfig.json file being used in the tailwindcss.com project. Go inspect the source code and have fun learning new things.

Happy coding!

Top comments (13)

Collapse
 
_fraganya profile image
Francis Ganya

Thanks for this dev

Collapse
 
naveennamani profile image
naveennamani Author

Also visit my GitHub repo for even more such scripts. Consider giving it a like 🤗

GitHub logo naveennamani / offline-docs

A collection of scripts to build offline documentation for your favourite frameworks/libraries. Simply search, copy/paste the commands and enjoy.

Offline-docs

A collection of scripts to build offline documentation for your favourite frameworks/libraries. Simply search, copy/paste the commands and enjoy.

Available tools

Currently 37 tools available

But why? / Motivation

Learning or working on a new language often requires referring to the official docs multiple times. With the rise of Static Site Generation (SSG) many documentation sites are now open-source and can be built for offline usage…

Collapse
 
_fraganya profile image
Francis Ganya

Sure thing.

Collapse
 
tajalasfiyaa profile image
TajAlasfiyaa Ishag

hello are still there

Collapse
 
paulschraven profile image
Paul Schraven

It's "yarn global add serve" :)

Collapse
 
naveennamani profile image
naveennamani Author

Thanks for pointing out, fixed.

Collapse
 
rejoanahmed2 profile image
Mohd Rejoan

everything works except last command "yarn"

Collapse
 
naveennamani profile image
naveennamani Author

Are you able to run yarn export and see the generated static HTML files in out directory? If you're not able to install serve package using yarn, try installing it using npm, or run npx serve.

Collapse
 
green8888elephant profile image
Kostya

For some reason there is no html pages and I cant run it

Image description

Collapse
 
naveennamani profile image
naveennamani Author

I'll try to look into this

Collapse
 
arielmeee profile image
arielmeee

Thanks man! I also love how you point out that pro tip.

Collapse
 
depeshpo profile image
Dipesh Paudel

Not working, need some updates maybe

Collapse
 
naveennamani profile image
naveennamani Author

Hi, can you please point out what error are you getting. I've no issue when I tried.

For the latest scripts you can always refer to my offline-docs repository. If you encounter any problems, you can also create a new issue in this repo.

What image format should you use in your next project? 🤔