Code Monkey home page Code Monkey logo

42-header-madrid's Introduction

๐Ÿš€ 42 HEADER MADRID ๐Ÿš€

42 Header Madrid is a plugin header for Vim and NeoVim, inspired by the 42 Paris Header and designed specifically for the 42 Madrid coding school. This header plugin enhances your code files with a beautiful and informative header containing information such as filename, author, email, and creation/update timestamps. The header is compatible with multiple programming languages.

๐Ÿ“ฆ Installation

Vim

  1. Download or clone this repository.
  2. Copy the stdheaderMAD.vim file to your ~/.vim/plugin directory.

NeoVim

  1. Download or clone this repository.
  2. In your init.lua file, add the following lines:
vim.g.user42 = 'yourLogin'
vim.g.mail42 = '[email protected]'

๐ŸŽฏ Usage

After the installation, you can use the plugin by simply pressing the <F1> key while editing a file. The header will be inserted at the beginning of the file.

๐Ÿ”ง Customization

You can customize the plugin by modifying the stdheaderMAD.vim file. The following variables are available for customization:

  • s:asciiart: The ASCII art for the header.
  • s:start, s:end, s:fill: Characters used to create the header's layout.
  • s:length, s:margin: Dimensions of the header.
  • s:types: A dictionary containing file extensions and the corresponding header styles.

Functions in the script handle various aspects of the header, such as:

  • s:filetype(): Determines the file type and sets the appropriate header style.
  • s:textline(): Generates a line of text within the header.
  • s:line(): Generates different lines of the header.
  • s:user(), s:mail(): Retrieve the user's name and email.
  • s:filename(), s:date(): Retrieve the filename and current date.

๐ŸŒŸ Contributing

If you would like to contribute to this project, feel free to create a fork of the repository and submit a pull request with your changes. We appreciate your help in making this plugin even better! ๐Ÿ’ช

If you need help, feel free to contact me on Slack! ๐Ÿ“ฉ My login is slegaris . ๐Ÿ˜Š not if you are a piscineer

42-header-madrid's People

Contributors

sanlega avatar

Stargazers

Santi avatar Alberto Dรญaz Lรณpez avatar abby avatar rvela-ca avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.