Obniżka cen

Dzień dobry, koledzy! Każdy po długiej drodze edukacyjnej chce pokazać pracodawcy swoje owoce i to tylko od najlepszej, profesjonalnej strony, prawda? Myślę, że tak. Dlatego oprócz poprawnie zaprojektowanego i zrealizowanego projektu musimy umieć go sformalizować. Pracodawca nie będzie czytał całego kodu Twojego projektu, żeby zrozumieć o co w nim chodzi i co się w nim zawiera? W tym artykule na koniec podsumujemy dwa poprzednie, a mianowicie: Ciągłą integrację i Pokrycie kodu , a także pozwolimy nam zrozumieć na „pierwszej” stronie projektu open source, czego użyliśmy w naszym projekcie i co to reprezentuje. Dziś porozmawiamy z Tobą o Markdown, zadamy nasze ulubione pytania: „Co to jest?” i „Dlaczego to jest?”, zastanówmy się, gdzie jest ono używane i jak z nim pracować. Będzie nawet przykład, zaimplementujemy go w naszym projekcie open source . Więc chodźmy!

Co to jest „Markdown”?

Ponieważ ty i ja jesteśmy programistami, natychmiast przejdziemy do Google i otworzymy pierwszy link do Wiki , który mówi: Markdown to lekki język znaczników stworzony w celu pisania najbardziej czytelnego i łatwego do edycji tekstu, ale odpowiedniego dla konwersja na języki dla zaawansowanych publikacji (HTML, Rich Text i inne). Tutaj, szczerze mówiąc, nie mam wiele do dodania, myślę, że to jest niemal idealne wyjaśnienie.

Dlaczego potrzebujemy tego „Markdown”?

Szczerze mówiąc, bez tego nie jest źle :D Ale pamiętajmy o naszym celu: napisać kompetentny szablon projektu, który ma już Continuous Integration i ma statystyki Code Coverage w zasobie Codecov. Dlaczego o tym wspomniałem? Co więcej, Markdown pozwoli nam pobrać dane z tych zasobów i dostarczyć same dane lub plakietki, które przekierują nas tam, gdzie potrzebujemy uzyskać te informacje. Wygodnie jest mieć wszystko na jednej stronie „tytułowej”, a nie rozproszone w różnych miejscach, prawda?

Gdzie jest używany?

Każdy, kto chociaż raz wrzucił jakiś swój projekt do GitHuba, wie, że GitHub uporczywie chce zaprosić Cię do stworzenia pliku README: Jakie jest rozszerzenie tego pliku? Zgadza się, Bolt zna Markdown! Jak już wiemy, plik ten można bardzo łatwo dostosować do wielu formatów i przekonwertować na potrzebny nam kod HTML. Ale nie spieszmy się i nie spieszmy się, aby od razu dodać go bezpośrednio do GitHuba.

Jak z tym pracować?

Po pierwsze, jak być może zauważyłeś, możemy dodać go bezpośrednio do GitHuba i zadziała! Ale nie zawsze musimy go dodawać na przykład tylko do jednego projektu. Lub na przykład chcemy więcej myśleć o tym, jak to tworzymy. I tutaj GitHub nie jest już dla nas odpowiedni. I ogólnie pliki Markdown możemy tworzyć nie tylko w celu wypychania ich do GitHuba. Po drugie, moglibyśmy go stworzyć bezpośrednio poprzez IDEA i właśnie to zrobimy, ale nie od razu, bo po co nam potężne środowisko programistyczne do napisania jednego małego pliku? Tutaj polecam przeglądać katalog łatwych i trudniejszych edytorów plików Markdown. Dla siebie wybrałem Haroopad , jest bardzo prosty, przystępny, natychmiast odzwierciedla to, co piszesz (IDEA też to robi) i ma wskazówkę dotyczącą składni. Tak wygląda okno edytora: Tutaj otworzyłem gotowy plik README.md jednego z moich projektów. Po lewej stronie znajduje się ściągawka, po prawej wyświetlacz, pośrodku tekst. Wszystko jest bardzo prymitywne i proste. Możesz także zobaczyć odznaki, o których porozmawiamy wkrótce. Ci, którzy wybiorą inny sposób zapisywania tych plików - nie przejmujcie się, jedyne, co będzie inne, to interfejs graficzny. Tekst, składnia i sposób wyświetlania pozostaną niezmienione. Przykład Zadanie jest bardzo proste: napisz plik README.md tak, aby zawierał: informacje o projekcie (w tym odznaki), informacje o imporcie projektu, informacje o realizacji projektu, informacje o kontaktach autora. Wszystko jest bardzo proste i prymitywne, jak już powiedziałem. Przejdźmy do interesów.

1. Napiszmy tytuł - nazwę naszego projektu.

   Główny i największy nagłówek tworzony jest za pomocą operatora skrótu „ # ”, a następnie zapisywany jest tytuł. W naszym przypadku:

   # ForJavaRushPublication

2. Następnie napiszemy nieco mniejszy tytuł i napiszemy „Informacje o projekcie”. Mniejszy nagłówek jest poprzedzony większą liczbą „ # ”:

   ## Information

   A potem napiszemy informację o projekcie.

3. Wstawiajmy linki do naszych artykułów. Odbywa się to bardzo prosto, a jeśli używasz Haroopad, po prostu wpisz ściągawkę, a szablon zostanie wstawiony sam. Składnia jest następująca: " [tekst](url) ";

4. Wstawmy odznaki. Przyjrzyjmy się tutaj bliżej.

   Najpierw dla urody ułóżmy je w formie stołu. Będą 2 kolumny i 2 kolumny. Składnia będzie wyglądać mniej więcej tak:

   A wynik będzie taki:

   Następnie wstawimy hiperłącza do naszych plakietek, ale gdzie je zdobyć? W poprzednim artykule pokazałem, gdzie zdobyć Codecov, ale nie wspomniałem, który wybrać. Ponieważ mamy plik Markdown, potrzebujemy również odznaki Markdown:

   Po prostu skopiuj go i wklej do kolumny w naszym Markdown. Ale nie zapominaj, że Codecov pojawił się w gałęzi JaCoCo, ale nie w masterze, więc będziesz musiał go poprawić ręcznie. Odznaka Travis CI znajduje się naprzeciwko nazwy projektu, gdzie dziennik budowy to:

   Wybieramy odznakę, po czym pojawia się okno ustawień:

   Zdecydowanie wybieramy Markdown i gałąź, której potrzebujesz. Zrobię plik README.md dla dwóch gałęzi i będą one nieco inne, ponieważ nie zaimplementowałem jeszcze Codecov w gałęzi master.




5. Napiszmy informację jak zaimportować lub sklonować ten projekt. Nie będę wyjaśniał, jak to zrobić, ale możesz to przeczytać w moim README.md. Napiszemy o technologiach, które zastosowaliśmy w naszym projekcie, zamieszczając linki do nich. Jest to jednak projekt edukacyjny. Cóż, zapiszmy dane kontaktowe.




6. Nasz Markdown jest gotowy. Pozostaje nam tylko dodać go do naszego projektu i gotowe. Ale nie wszystko na raz! Otwórzmy nasz POMYSŁ, a we wtyczkach sprawdzamy, czy masz obsługę Markdown:

   Mam Ultimate IDEA, więc mam wszystko, Twoja wtyczka może nie być domyślnie zainstalowana, ale gdy tworzysz plik z rozszerzeniem md, powinieneś zostać poproszony o jej pobranie. Pobierz i uruchom ponownie swój IDEA.




7. Po zaimportowaniu napisanego przez nas Markdowna otwórz go za pomocą IDEA i edytuj, jeśli to konieczne. Tak to wygląda poprzez IDEA:

   Pchamy. Następnie widzimy, że podczas otwierania projektu informacje o nim są natychmiast ładowane, to jest nasz plik README.md:

   Teraz klikając na plakietkę możemy od razu przejść do montażu projektu i zobaczyć co tam mamy i jak.




8. Zrobię to samo dla oddziału JaCoCo, aby zademonstrować Codecov Badge, ponieważ nie mamy jeszcze w nim pliku README.md. W rezultacie mamy teraz dwie odznaki:

   Codecov pokazuje procent pokrycia kodu, może także przekierować nas na stronę Codecov i wyświetlić szczegółowy raport pokrycia kodu.

Przydatne linki

• Co Wiki mówi nam o Markdown;
• Katalog redaktorów Markdown ;
• Haroopad , który polecam;
• O Markdown na stronie JetBrains ;
• Markdown Navigator na tym samym JetBrains;
• Odznaki i wszystko co z nimi związane. Tutaj możesz wybrać styl dowolnej odznaki i dostosować ją do własnych potrzeb;
• Jak zaktualizować swój projekt open source? W tym artykule znajdziesz również odpowiedź ;
• Poprzedni artykuł

Podsumujmy cykl moich artykułów

1. Czym jest CI, do czego służy i jak go używać, sprawdziliśmy w pierwszym artykule o ciągłej integracji ;
2. Bawiliśmy się CC i zrozumieliśmy, co to jest i dlaczego jest potrzebne, w drugim artykule o pokryciu kodu ;
3. W tym artykule przyjrzeliśmy się, czym jest Markdown, dlaczego jest potrzebny i jak skutecznie go używać.

Dziękuję wszystkim za przeczytanie tych trzech długich artykułów. Mam nadzieję, że okazały się przydatne. W tekście mogą występować błędy i pominięcia. Dziękuję wszystkim za uwagę!