markdown-toc Atom package: problem with underscores in headings

-
markdown-toc (version 0.4.2) is an Atom (version 1.28.0) package that generates a table of contents from all your markdown headings. However, when generating links for headings having underscores (e.g. "The file logging_conf.json") by markdown-toc, the underscores are ignored in the generated relative URLs. GitHub needs the underscores within the headings' URLs so your internal links work correctly.

Underscores are ignored by default by the markdown-toc package when generating the relative URLs for the internal links in the TOC

Thus, you will have to modify the regex used by markdown-toc for ignoring some characters (e.g. underscore) in the headings when forming the relative links. In order to do so, do the following:
  1. Go to Atom->Preferences..., then click on Open Config Folder.

  2. On the Project tab, search for the file TOC.coffee that you can find within the folder packages/markdown-toc/lib/.
  3. Find the line
    hash = hash.replace /[^a-z0-9\u4e00-\u9fa5äüö\-]/g, ""
    which can be found at line # 197.
  4. Modify the regex by adding the characters \_ like this:
    hash = hash.replace /[^a-z0-9\u4e00-\u9fa5äüö\-\_]/g, ""
  5. Save everything, restart Atom, and re-open your project.
  6. Toggle the markdown-toc package to regenerate your TOC with the URLs having the underscores. Now, your internal links with underscores are working under GitHub markdown files (e.g. README.md).

    Yeah! The underscores are not ignored anymore in the relative URLs by markdown-toc

Comments

Post a Comment

Popular posts from this blog

Install the MAMP (Mac, Apache, MySQL, PHP) stack

-
Image
There are two ways that you could install ( freely ) the whole MAMP stack: installing the MAMP (version 4.5) software bundle is the easiest way since it is a one-click-solution for setting up a personal webserver install each components (Apache, MySQL, and PHP) separately. This second method consists in installing Apache and PHP with Homebrew, and MySQL with the  package Installer . It is the hardest method but it enables you more control over the installation process, e.g you can install specific versions of each components, or install extra PHP extensions. NOTE:  MAMP 4.5, Apache 2.4.33, MySQL 8.0.11, PHP 7.2.7, and phpMyAdmin 4.8.2 are installed in the following tutorial Contents 1. Method 1: install the MAMP software bundle 2. Method 2: install each components (Apache, MySQL, and PHP) separately      2.1 Apache+PHP           2.1.1 Install Apache+PHP           2.1.2  Change Apache's default ports           2.1.3  Start the Apache server           2.1
Read more

Deactivate conda's base environment on startup

-
Image
When opening a terminal session, conda activates the base environment by default. If you want to prevent this default behaviour, you have three ways: Trick #1  :  Set the auto_activate_base parameter to false Trick #2  : Add conda deactivate in your bash configuration file Trick #3  :  Comment out some part of the conda initialisation code block in your bash configuration file NOTES: I'm working with  conda version 4.7.5 and  miniconda3 (it should also work with anaconda ). These tricks also worked with  conda version 4.6.14 After installing conda 4.7, conda added this block of code in my ~/.bash_profile : This is the block of code that we will modify in the following tricks Trick #1: set auto_activate_base  to false Per conda's instructions, "if you'd prefer that conda's base environment not be activated on startup, set the auto_activate_base parameter to false". Thus, enter the following command in a terminal: conda config --set
Read more

Product review: SMONET wireless security camera system

-
Image
I bought a security camera system from SMONET which consists of 4 wireless [1] bullet IP cameras with night vision: each camera comes with its power adapter [2] . There is an optional Ethernet port on each camera. The camera has an image resolution of 1280*960P . An NVR (Network Video Recorder) system: it comes with its power adapter, a mouse, and an Ethernet cable to connect the NVR to a router. In the Amazon product page  (product description section), they talk about 2 USB2.0 Port but my NVR only has 1 USB2.0 Port in the back, and you can also see it in the user manual  (page 3) that there is only one USB2.0 Port in the back of the NVR. This NVR doesn't come with a hard drive; you have to buy it separately. It is important to stress that if you plan on having a robust security camera system that is very reliable and secure 24 hours a day, 7 days a week, you should opt for a wired security camera system. This wireless security camera system allows you to change the w
Read more